From ca4111ac7779b1d3581df5e7d5616ed402735e1c Mon Sep 17 00:00:00 2001
From: "Scott E. Graves" <scott.e.graves@protonmail.com>
Date: Wed, 25 Sep 2024 07:33:56 -0500
Subject: [PATCH] updated readme

---
 .cspell/words.txt |  5 ++++-
 README.md         | 27 ++++++++++++++++++++++++---
 2 files changed, 28 insertions(+), 4 deletions(-)

diff --git a/.cspell/words.txt b/.cspell/words.txt
index a5c9ea70..fdf4d055 100644
--- a/.cspell/words.txt
+++ b/.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
@@ -211,4 +214,4 @@ wsign-conversion
 wunused
 wuseless
 wxwidgets_version
-xattr
+xattr
\ No newline at end of file
diff --git a/README.md b/README.md
index 73e63cea..fdb3ae49 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Repertory
 
-Repertory allows you to mount AWS S3 and Sia via FUSE on Linux~~/OS X~~ or via WinFSP
+Repertory allows you to mount AWS S3 and Sia via FUSE on Linux ~~/OS X~~ or via WinFSP
 on Windows.
 
 ## Details and Features
@@ -8,9 +8,9 @@ on Windows.
 * Optimized for [Plex Media Server](https://www.plex.tv/)
 * Single application to mount AWS S3 and/or Sia
 * Only 1 Sia mount and 1 S3 mount (per bucket) per user is supported.
-* Remote mounting of Repertory instances on Linux~~, OS X~~ and Windows
+* Remote mounting of Repertory instances on Linux ~~, OS X~~ and Windows
   * Securely share your mounts over TCP/IP (`XChaCha20-Poly1305` stream cipher)
-* Cross-platform support (Linux 64-bit, Linux arm64/aarch64,~~OS X,~~ Windows 64-bit)
+* Cross-platform support (Linux 64-bit, Linux arm64/aarch64, ~~OS X,~~ Windows 64-bit)
 
 ## Minimum Requirements
 
@@ -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/)