From 349fc5c37a10351d64d0e7c8755b8133602cfc7f Mon Sep 17 00:00:00 2001
From: Antoine Cyril David Hoffmann <ahoffman@spcpc606.epfl.ch>
Date: Tue, 27 Oct 2020 12:03:09 +0100
Subject: [PATCH] added basic instructions

---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index 6fccc1cc..9351e866 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,12 @@
 HeLaZ (Hermite-Laguerre Z-pinch solver, 2020)
 
+How to run it :
+
+1. Be sure to have correct paths in local/dirs.inc for the different libraries
+2. You can compile from HeLaZ/ using make and launch from HeLaZ/wk using ./../bin/HeLaZ
+3. To have a better interface, open a script HeLaZ/wk/parameters*.m and run it to set up a wanted simulation.
+4. You can obtain various plots and gifs using HeLaZ/wk/analysis_2D.m once the simulation is done. To select the correct output file, run parameters*.m with the corresponding simulation parameters and then run analysis_2D.m (everything with matlab from wk/)
+
 Roadmap : (Current version 1.4)
 
 0. Write MOLI matlab solver in Fortran using Monli1D as starting point
-- 
GitLab