updated the READme

fccoelho · Dec 18, 2024 · 3ad65dd · 3ad65dd
1 parent aad495b
commit 3ad65dd
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 15 deletions.
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/README.md b/README.md
@@ -28,7 +28,20 @@ Besides installing epigrass from the PyPI, as described below you will need to i
 You can install Epigrass directly from PyPI, the Python Package Index.
 For mode details, check the [docs](https://epigrass.readthedocs.io/en/latest/install.html#)
 
+## Installing from the repository
+If you clone the repository, you can install Epigrass with the following command:
+```bash
+$ uv sync
+```
+
+## Running demos
+The source distribution comes with a few demos.
+```bash
+$ cd demos
+$ uv run epirunner rio.epg
+```
+This will run the demo for the city of Rio de Janeiro. 
 
-## Getting Started
+## Getting started building your own models
 
 Folow [these instructions](https://epigrass.readthedocs.io/en/latest/using.html).