Docs, is-named bool functions and MSVC utf-8

README.md

@@ -11,22 +11,55 @@ This application was developed with the assistance of a large language model.
 
 ## Build
 
-After cloning and enter the repository's directory, make sure to initialize the submodules:
+After cloning and entering the repository's directory, make sure to initialize the submodules:
+
 ```git submodule update --init --recursive```
 
-### Windows
-Visual Studio is recommended for build.
+Everything (SDL, Dear ImGui, simdjson, stb_vorbis) is built statically from the submodules. The game's resources are in `resources/` and get linked next to the executable (copied, where links aren't allowed). Release is the default build; add `-DCMAKE_BUILD_TYPE=Debug` to the first command for a debug one.
 
 ### Linux
 
+Needs the X11/Wayland and audio headers SDL builds against.
+
 ```
 mkdir build
 cd build
 cmake ..
-make 
+make
 ```
 
-If using VSCode, several tasks are available to quickly run and build.
+### Windows
 
-### Emscripten
-Run the VSCode "web" task. Make sure you have the Emscripten SDK accessible at the EMSDK path variable.
+With Visual Studio or MinGW:
+
+```
+cmake -B build
+cmake --build build --config Release
+```
+
+### Web
+
+Needs the [Emscripten SDK](https://emscripten.org/docs/getting_started/downloads.html).
+
+```
+emcmake cmake -B build-web
+cmake --build build-web
+```
+
+This makes `index.html`, `.js`, `.wasm` and `.data`. Serve all four.
+
+## Saves
+
+Settings are kept in `settings.txt`, and each character's progress in `saves/<character>.txt`, as plain `key=value` lines. They're in `~/.local/share/shweets-sim` on Linux, `%AppData%/shweets-sim` on Windows, and the browser's storage on the web.
+
+## Developer Console
+
+Add `console=1` to `settings.txt`, then press the grave key (`` ` ``) in game. `help` lists the commands.
+
+## Modding
+
+See [MODDING.md](MODDING.md).
+
+## License
+
+See [LICENSE](LICENSE).