diff --git a/README.md b/README.md index added9d..145fc56 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,9 @@ $ pip install uv ### 3. Activate the Virtual Environment ```bash +# Set up .venv if haven't yet +$ uv venv + # On MacOS and Linux. $ source .venv/bin/activate @@ -53,3 +56,15 @@ streamlit run app.py ``` This will launch the app, and you can access it by navigating to http://localhost:8501 in your browser. + + +## Project Directory +```bash +├── app.py # main entry used by streamlit to activate app +├── data/ # contains graph input examples +├── drawings/ # contains generated graphs, no need to be touched +├── labelg # labelg C program +├── lib/ # contains code auto generated by pyvis, no need to be touched +├── out/ # contains canonical output +├── src/ # contains scripts for the program +```