Merge branch 'main' of https://github.com/ci-group/ariel

Author: A-lamo

.vscode/tasks.json

@@ -11,13 +11,14 @@
                 "run",
                 "${file}"
             ],
+            "presentation": {
+                "reveal": "always",
+                "panel": "new",
+                "clear": true
+            },
             "group": {
                 "kind": "build",
                 "isDefault": true,
-                "presentation": {
-                    "reveal": "always",
-                    "panel": "new"
-                }
             },
         },
         {

README.md

@@ -15,16 +15,30 @@
 * [vscode containers tut](https://code.visualstudio.com/docs/devcontainers/tutorial)
 
 --- -->
+
+## Documentation
+[ARIEL main documentation page](https://ci-group.github.io/ariel/)
+
 ## Installation and Running
 
 This project uses [uv](https://docs.astral.sh/uv/).
 
-To run the code examples please do
-
+To run the code examples, please do:
+1. Clone the repository
+```bash
+git clone https://github.com/ci-group/ariel.git
+```
+3. Create a uv virtual environment inside the repository folder
+```bash
+  uv venv
+```
+4. Sync the virtual environment with the requirements
 ```bash
-uv venv
 uv sync
-uv run examples/z_ec_course/0_render_single_frame.py
+```
+5. Run an example, in this case, brain evolution (aka learning) using:
+```bash
+uv run examples/re_book/1_brain_evolution.py
 ```
 
 <!-- ## TODO: Installation

docs/source/installation_guide.md

@@ -15,6 +15,26 @@ ARIEL contains and requires many other libraries to function properly, and avoid
 
 ## Installation with uv
 
+The current version of ARIEL is only available on GitHub. This page will be updated once an alternative installation method is made.
+
+### Installation Steps
+1. Clone the repository
+```bash
+git clone https://github.com/ci-group/ariel.git
+```
+3. Create a uv virtual environment inside the repository folder
+```bash
+  uv venv
+```
+4. Sync the virtual environment with the requirements
+```bash
+uv sync
+```
+5. Run an example, in this case, brain evolution (aka learning) using:
+```bash
+uv run examples/re_book/1_brain_evolution.py
+```
+<!-- 
 1. Install `uv` (if not already installed):
 
 ```bash
@@ -34,7 +54,7 @@ Run the following command to have uv create a virtual environment, double check
 uv sync
 ```
 
-You can activate the uv virtual environment the same way you would activate a normal one using `.\.venv\Scripts\activate`
+You can activate the uv virtual environment the same way you would activate a normal one using `.\.venv\Scripts\activate` -->
 
 ## Installation using dev containers