add alias info to README

lukasn9 · Mar 20, 2024 · a3ec36f · a3ec36f
1 parent f3be181
commit a3ec36f
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/scripts/gardenshed/README.md b/scripts/gardenshed/README.md
@@ -0,0 +1,17 @@
+## Alias configuration
+
+### Mac
+add the following to the end of your `.zprofile`:
+```alias spade="cd ~/Work/sprig/firmware/spade"
+export PATH=/Users/graham/Work/sprig/firmware/gardenshed:$PATH
+alias gardenshed="python3 /Users/graham/Work/sprig/firmware/gardenshed/gardenshed.py"
+alias gs="python3 /Users/graham/Work/sprig/firmware/gardenshed/gardenshed.py"
+```
+### Ubuntu
+add the following to the end of your `.bash-rc`:
+```alias spade="cd ~/Work/sprig/firmware/spade"
+export PATH=/Users/graham/Work/sprig/firmware/gardenshed:$PATH
+alias gardenshed="python3 /Users/graham/Work/sprig/firmware/gardenshed/gardenshed.py"
+alias gs="python3 /Users/graham/Work/sprig/firmware/gardenshed/gardenshed.py"
+```
+