updated readme

.cspell/words.txt

@@ -136,6 +136,7 @@ linkflags
 mbig
 msvc
 msvcr120
+msys2
 mtune
 nana
 ncrypt
@@ -148,6 +149,7 @@ oleaut32
 openal_version
 openssldir
 pkgconfig
+plex
 project_enable_fontconfig
 project_enable_gtkmm
 project_enable_libdsm
@@ -160,6 +162,7 @@ puint32
 pvoid
 pwstr
 remote_winfsp
+renterd
 richtext
 rocksdb_library
 rpcrt4

README.md

@@ -29,6 +29,27 @@ on Windows.
 * ~~OS X Mojave and above~~
 * Windows 64-bit 10, 11
 
+## Compiling
+
+* Successful compilation will result in all required files being placed in the `dist/` directory
+* Linux
+  * Ensure `docker` is installed
+    * For x86_64:
+      * Release: `scripts/make_unix.sh x86_64`
+      * Debug: `scripts/make_unix.sh x86_64 debug`
+    * For aarch64:
+      * Release: `scripts/make_unix.sh aarch64`
+      * Debug: `scripts/make_unix.sh aarch64 debug`
+* Windows
+  * RECOMMENDED: Cross-compiling on Linux
+    * Ensure `docker` is installed
+      * Release: `scripts/make_win32.sh`
+      * Debug: `scripts/make_win32.sh debug`
+  * Compiling on Windows
+    * Ensure latest [MSYS2](https://www.msys2.org/) is installed
+      * Release: `scripts/make_win32.cmd`
+      * Debug: `scripts/make_win32.cmd debug`
+
 ## Credits
 
 * [boost c++ libraries](https://www.boost.org/)