From 3ad65dd6604be8efe3c33077e9af188110c8ee38 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fl=C3=A1vio=20Code=C3=A7o=20Coelho?= <fccoelho@gmail.com>
Date: Wed, 18 Dec 2024 19:23:03 -0300
Subject: [PATCH] updated the READme

---
 .idea/workspace.xml | 20 ++++++--------------
 README.md           | 15 ++++++++++++++-
 2 files changed, 20 insertions(+), 15 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index c17dd12..23a2886 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -31,17 +31,9 @@
     <select />
   </component>
   <component name="ChangeListManager">
-    <list default="true" id="991a2459-6152-47ff-ac53-e228bf684060" name="Default" comment="fixed many bugs and started migrating to pyproject.toml">
+    <list default="true" id="991a2459-6152-47ff-ac53-e228bf684060" name="Default" comment="fixed many bugs">
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Epigrass/epipanel.py" beforeDir="false" afterPath="$PROJECT_DIR$/Epigrass/epipanel.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Epigrass/manager.py" beforeDir="false" afterPath="$PROJECT_DIR$/Epigrass/manager.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Epigrass/models.py" beforeDir="false" afterPath="$PROJECT_DIR$/Epigrass/models.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Epigrass/simobj.py" beforeDir="false" afterPath="$PROJECT_DIR$/Epigrass/simobj.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/demos/CustomModel.py" beforeDir="false" afterPath="$PROJECT_DIR$/demos/CustomModel.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/demos/rio.epg" beforeDir="false" afterPath="$PROJECT_DIR$/demos/rio.epg" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/demos/spread.gml" beforeDir="false" afterPath="$PROJECT_DIR$/demos/spread.gml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/demos/spread.graphml" beforeDir="false" afterPath="$PROJECT_DIR$/demos/spread.graphml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/demos/spread.json" beforeDir="false" afterPath="$PROJECT_DIR$/demos/spread.json" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -542,7 +534,7 @@
       <workItem from="1608401847529" duration="81000" />
       <workItem from="1613904327797" duration="8348000" />
       <workItem from="1615726523518" duration="5251000" />
-      <workItem from="1734520183776" duration="14413000" />
+      <workItem from="1734520183776" duration="15167000" />
     </task>
     <task id="LOCAL-00014" summary="Functioning dashboard for simulations&#10;fixed bug in committing transactions to sqlite">
       <created>1582368099002</created>
@@ -887,7 +879,7 @@
       <option name="project" value="LOCAL" />
       <updated>1615727183521</updated>
     </task>
-    <option name="localTasksCounter" value="64" />
+    <option name="localTasksCounter" value="65" />
     <servers />
   </component>
   <component name="TypeScriptGeneratedFilesManager">
@@ -919,7 +911,6 @@
     </option>
   </component>
   <component name="VcsManagerConfiguration">
-    <MESSAGE value="Optimization of the call sequence of epipanel" />
     <MESSAGE value="Switched map drawing to altair for performance reasons.&#10;&#10;Added panel with simulation metadata." />
     <MESSAGE value="Further improvements on Altair visualizations" />
     <MESSAGE value="Added encoded favicon in the code." />
@@ -944,7 +935,8 @@
     <MESSAGE value="removed cython import from setup.py" />
     <MESSAGE value="bumped up minor version" />
     <MESSAGE value="fixed many bugs and started migrating to pyproject.toml" />
-    <option name="LAST_COMMIT_MESSAGE" value="fixed many bugs and started migrating to pyproject.toml" />
+    <MESSAGE value="fixed many bugs" />
+    <option name="LAST_COMMIT_MESSAGE" value="fixed many bugs" />
   </component>
   <component name="XDebuggerManager">
     <watches-manager>
diff --git a/README.md b/README.md
index 648aa01..42f019d 100644
--- 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).