Updated README

Author: max-models

.gitignore

@@ -180,4 +180,7 @@ cython_debug/
 */.DS_Store
 
 # Python environments
-env*
+env*
+
+# VS code
+.vscode/

README.md

@@ -1 +1,23 @@
-# maxplotlib
+# maxplotlib
+
+## Install
+
+Create and activate python environment
+
+```
+python -m venv env
+source env/bin/activate
+pip install --upgrade pip
+```
+
+Install the code and requirements with pip
+
+```
+pip install -e .
+```
+
+Run the code with
+
+```
+maxplotlib
+```