From 3dac8c3e14df1ab6b025912d07630e5795e43f38 Mon Sep 17 00:00:00 2001 From: Gavin Rohrer Date: Wed, 30 Sep 2020 08:11:09 -0400 Subject: [PATCH] Updated README --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b91140b..383c144 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,15 @@ # classes +## Configuration + to configure: change values in config.json to reflect your classes and periods --- -# Building from source +## Building from Source -1) install pyinstaller via pip -2) run the following command: `pyinstaller --add-data 'config.json;.' main.py` \ No newline at end of file +1. Install [pyinstaller](https://pypi.org/project/pyinstaller/) via pip +2. Configure config.json to reflect your classes and periods +3. Run the following command: + - **Windows:** `pyinstaller --add-data 'config.json;.' main.py` + - **Linux and macOS:** `pyinstaller --add-data 'config.json:.' main.py` \ No newline at end of file