From 294f7f78fe3e81bef2c23750426b53354b1b20a6 Mon Sep 17 00:00:00 2001
From: ConfuSomu
Date: Thu, 23 May 2024 02:28:41 -0400
Subject: Make building instructions in readme more clear

Explain more precisely how to get git submodules, and mention that
mastodonpp support can be disabled.
---
 README.md | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index d29354d..bbead54 100644
--- a/README.md
+++ b/README.md
@@ -15,15 +15,20 @@ Furthermore, support for viewing replies to your posts will be added. I also wan
 
 ## Building
 
-To build, please have CMake and the Qt library installed. You will also need [mastodonpp](https://schlomp.space/tastytea/mastodonpp/), which can be retrieved by initializing git submodules.
+To build, have a C++17-compliant compiler, CMake 3.9 or later, and the Qt 5 or 6 library installed. This repo uses git submodules which can be fetched by recursively cloning (`git clone --recurse-submodules`) or initializing submodules afterwards (`git submodule update --init`).
 
-Simply said, after install CMake and Qt from your package manager, do the following to build the project:
+That should get dependencies which currently are [mastodonpp](https://schlomp.space/tastytea/mastodonpp/). Note that when asking CMake to generate the build files, you can disable mastodonpp support by passing `-DMASTODONPP_BUILD=0`.
+
+Simply said, after installing CMake and Qt from your package manager, do the following to build the project:
 
 ```
 git clone --recurse-submodules https://git.twilightsparkle.space/ActorViewer && cd ActorViewer
-cmake -B build -DCMAKE_BUILD_TYPE=Debug             # Initially and if CMakeLists.txt changes
-cmake --build build -j$(nproc --all) --target all   # To build
-cmake --build build -j$(nproc --all) --target clean # To clean
+
+# Generate build files (initially and if CMakeLists.txt changes)
+cmake -B build -DCMAKE_BUILD_TYPE=Debug
+
+# Build!
+cmake --build build -j$(nproc --all) --target all
 ```
 
 I plan to make a Flatpak in the near future so that manually building will not be necessary.
-- 
cgit v1.2.3-54-g00ecf