From 85bdfa7cd0808140ff81f4b3de0a98f939b5905e Mon Sep 17 00:00:00 2001
From: Ben Yanke <ben@benyanke.com>
Date: Sat, 17 Aug 2024 09:09:18 -0400
Subject: [PATCH 1/3] Add build instructions

---
 .gitignore |  5 ++++-
 README.md  | 30 ++++++++++++++++++++++++++++++
 compile.sh |  3 +++
 3 files changed, 37 insertions(+), 1 deletion(-)
 create mode 100755 compile.sh

diff --git a/.gitignore b/.gitignore
index d01bd1a..a988b95 100644
--- a/.gitignore
+++ b/.gitignore
@@ -18,4 +18,7 @@ Cargo.lock
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
\ No newline at end of file
+#.idea/
+
+# nano tmp files
+.*.swp
diff --git a/README.md b/README.md
index ad3e87f..a05802d 100644
--- a/README.md
+++ b/README.md
@@ -58,6 +58,36 @@ The diagram above took too long to create, so I no longer have the energy to wri
 
 On a more serious note: Google Calendar is a wonderful service. I'd highly discourage anyone from using this for anything other than educational purposes. Abusing a free service is wrong—don't be evil.
 
+## Usage
+### Compiling in Docker
+
+If you have docker installed, you can compile with the following command:
+
+```sh
+docker run -v `pwd`:/app --workdir="/app" --rm -it rust:1.80 bash -c "apt-get update && apt-get install -y libfuse3-dev && cargo build"
+```
+
+When it completes, you will have the binary available at: `target/debug/when-fs`
+
+### Setting Up
+
+Confirm the binary compiled correctly by running `target/debug/when-fs --help`. You should see output like this:
+
+```sh
+$ target/debug/when-fs --help
+Usage: when-fs [OPTIONS] --secret <SECRET>
+
+Options:
+      --mount <MOUNT>            
+      --secret <SECRET>          
+      --name <NAME>              
+      --calendar <CALENDAR>      
+      --root-event <ROOT_EVENT>  
+  -h, --help                     Print help
+```
+
+
+
 ## Contributions
 
 Contributions are more than welcome.
diff --git a/compile.sh b/compile.sh
new file mode 100755
index 0000000..587f2e4
--- /dev/null
+++ b/compile.sh
@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+docker run -v `pwd`:/app --workdir="/app" -it rust bash -c "apt-get update && apt-get install -y libfuse3-dev && cargo build"

From 02ea60b634a3434b64fd17b00991d44e91a67e29 Mon Sep 17 00:00:00 2001
From: Ben Yanke <ben@benyanke.com>
Date: Sat, 17 Aug 2024 09:12:20 -0400
Subject: [PATCH 2/3] rename

---
 compile.sh => dockerCompile.sh | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename compile.sh => dockerCompile.sh (100%)

diff --git a/compile.sh b/dockerCompile.sh
similarity index 100%
rename from compile.sh
rename to dockerCompile.sh

From 29168ecc91551603fba971154f09296cb93e24dc Mon Sep 17 00:00:00 2001
From: Ben Yanke <ben@benyanke.com>
Date: Sat, 17 Aug 2024 09:13:11 -0400
Subject: [PATCH 3/3] add comment

---
 dockerCompile.sh | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/dockerCompile.sh b/dockerCompile.sh
index 587f2e4..a1582c9 100755
--- a/dockerCompile.sh
+++ b/dockerCompile.sh
@@ -1,3 +1,5 @@
 #!/usr/bin/env bash
 
 docker run -v `pwd`:/app --workdir="/app" -it rust bash -c "apt-get update && apt-get install -y libfuse3-dev && cargo build"
+
+# compiles file to target/debug/when-fs