diff --git a/README.md b/README.md index 606186e..8f0ee5f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,12 @@ -# map +# Sunset Simulator + +## Organization + +The code is separated into two parts: +- GUI file: [app.py](app.py) +- "header" file: [skydome.py](skydome.py) + + to use the gui first - set up the environment @@ -6,13 +14,19 @@ to use the gui first ## environment setup - +### Windows ``` > python3 -m venv .venv > venv\Scripts\activate > pip install -r requirements.txt ``` +### Linux/Mac +``` +> python3 -m venv .venv +> source .venv/bin/activate +> pip install -r requirements.txt +``` ## running the gui