docs + plot title

README.md

@@ -1,7 +1,3 @@
-# Crash course on Python installation, with a few small side tracks
-
-
-
 # Installation
 1. If not already done so, create a virtual environment to contain all the packages required. Python 3.10 is recommended. The command below will create a new environment named 'app-env' with the latest version of Python 3.10.
 
@@ -13,4 +9,38 @@ conda activate app-env
 
 3. The prompt should now read '(app-env)' on the left. The app is not published on Github or anywhere else. The link below points to my own personnal home server (I didn't find any way of getting a direct download link  You are now ready to install everything with this command:
 
-pip install https://bao.dedebenui.me/s/f3KgiqMq7giN73i/download
+pip install "git+file://<path to the git repository>"
+
+# Usage
+
+1. Make sure your environment is activated (step 1 above)
+
+2. call the `dispersionapp` command
+
+dispersionapp
+
+2*. this can be also done via calling python first (`-m` tells python to open the specified module)
+
+python -m dispersionapp
+
+# Interface
+
+On the top left, you will see a summary of the current configuration. On the right, you will find the paremter list.
+
+from left to right :
+- the name of the paramter
+- a slider to quickly explore values
+- arrow buttons to move from one value to the next
+- a text box where you can input your desired value. The closest possible value will then be selected.
+- a button to automatically "play" the parameter from its current positition to its maximum
+- interval during which each parameter is displayed while playing.
+
+To navigate the plot:
+- left-click + drag to move around
+- right-click + drag to zoom
+- scroll wheel to zoom
+- for each kind of movement, you can do it while the cursor is hovering over one of the axis. In that case, only that axis is affected.
+- to go back to a view that fits everything, click on the small "A" at the bottom left.
+- to hide/show a line, click on it in the legend. You can also click+drag on the legend to move it around.
+- double click on the purple title bar (left side or top) to pop out the plot in its own window.
+