Skip to content

Commit

Permalink
docs: add documentation for project directory
Browse files Browse the repository at this point in the history
  • Loading branch information
hanpham32 committed Dec 7, 2024
1 parent 04f7ad3 commit 7296445
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
```

0 comments on commit 7296445

Please sign in to comment.