Merge pull request #11 from instadeepai/docs/installation-readme

Added to instructions
instadeepai · Jan 23, 2024 · 1c44159 · 1c44159
2 parents 0ef4cc2 + 4740731
commit 1c44159
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,8 @@ launch.json
 .vscode
 json_logs
 vaults
+logs
+__MACOSX
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

diff --git a/README.md b/README.md
@@ -111,9 +111,16 @@ We have generated datasets on a diverse set of popular MARL environments. A list
 
 ## Quickstart 🏁
 
-### Instalation 🛠️
+### Installation 🛠️
 
-To install og-marl run the following command.
+Start by cloning this repository:
+`git clone https://github.com/instadeepai/og-marl.git`
+
+Navigate into the og-marl directory.
+
+`cd og-marl`
+
+To install og-marl and its dependencies run the following command in a virtual environment (e.g. conda).
 
 `pip install -e .`