#1 - quicr module

README.md

@@ -1,28 +1,39 @@
-# mmo
+# Towards
 
-Game engine demo with built-in networking for multiplayer.
+Game engine built as a modular monolith.
 
 ## Building
 
 Dependencies:
-- SDL2
+- Conan 2 (`pipx install conan`, or `pip install conan`)
 - Vulkan SDK
 
-Both need to be downloaded before building. Do not forget to set PATH on Windows.
+The Vulkan SDK must be installed before building. Do not forget to set PATH on Windows.
 
+On Linux, Conan builds SDL2 from source and still needs the system OpenGL/X11/Wayland/ALSA development headers present.
 
-This command will initialize the build directory: `build/`
+First time only, create a Conan profile describing your compiler:
 
 ```bash
-$ cmake -S . -B ./build/
+$ conan profile detect
 ```
 
-This will build the entire project.
+Install the pinned dependencies and generate the CMake toolchain + presets:
 
 ```bash
-$ cmake --build ./build
+$ conan install . --output-folder=build --build=missing -s build_type=Debug
 ```
 
+Configure and build using the generated preset:
+
+```bash
+$ cmake --preset conan-debug
+$ cmake --build --preset conan-debug
+```
+
+For a release build, repeat both steps with `-s build_type=Release` and the
+`conan-release` preset.
+
 There are now two executables:
 
 Server is at `build/modules/client/mmo_server`
@@ -30,4 +41,3 @@ Server is at `build/modules/client/mmo_server`
 Client is at `build/modules/client/mmo_client`
 
 First run the server, so that client can connect. The server will try to use port 8080, but if it is already occupied, it will try use the next free higher one.
-