From b323a2d6aa80878df3b5afc7677d09d5f0349514 Mon Sep 17 00:00:00 2001
From: Alexis GAMELIN <alexis.gamelin@synchrotron-soleil.fr>
Date: Thu, 31 Mar 2022 16:25:41 +0200
Subject: [PATCH] Update README.md

---
 README.md | 36 +++++++++++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0543c4a..47e8f6c 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,41 @@ mbtrack2 is composed of different modules allowing to easily write scripts for s
 
 Installation
 ------------
-TODO
+Clone the mbtrack2 repo and enter the repo:
+```
+git clone https://gitlab.synchrotron-soleil.fr/PA/collective-effects/mbtrack2.git
+cd mbtrack2
+```
+
+### Using conda
+
+To create a new conda environment for mbtrack2 run:
+
+```
+conda env create -f mbtrack2.yml
+conda activate mbtrack2
+```
+
+Or to update your current conda environment to be able to run mbtrack2:
+
+```
+conda env update --file mbtrack2.yml
+```
+
+To test your installation run:
+```
+from mbtrack2 import *
+```
+
+### Using pip
+
+```
+pip install -r requirements.txt
+```
+To test your installation run:
+```
+from mbtrack2 import *
+```
 
 References
 ----------
-- 
GitLab