From c7b76cd99f3026b47cba09c9b08cf2d2a213e773 Mon Sep 17 00:00:00 2001 From: Bryson Steck Date: Wed, 23 Mar 2022 22:03:58 -0600 Subject: update readme with macos instructions --- README.md | 4 ++++ doc/MACOS.md | 6 +++--- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9c55883..cc9bab4 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,10 @@ python3 pip3 ``` +The following instructions are for Linux (and possibly other \*NIX systems). You can view the installation instructions for macOS and Windows here: +* [macOS](doc/MACOS.md) +* [Windows]() (COMING SOON) + You can install these with the following commands in these distros: ### Ubuntu/Debian ```bash diff --git a/doc/MACOS.md b/doc/MACOS.md index 8dc9379..9f3435f 100644 --- a/doc/MACOS.md +++ b/doc/MACOS.md @@ -9,8 +9,8 @@ If you have the tools installed, `git` will display a help message. If you don't You will also need to install Node.js and npm, both of which can be installed through one package found on the downloads section of the [Node.js Website](https://nodejs.org/en/download/). Once you have both items installed, you will be able to run the same files (`install.sh` and `run.sh`) as you would on Linux: -``` +```bash # note: if you use './install.sh' or './run.sh', the read command may not work properly -$ sh install.sh -$ sh run.sh +% sh install.sh +% sh run.sh ``` -- cgit v1.2.3