improved README

2024-06-07 14:54:14 +02:00
parent b0a64aba0e
commit 8dc52594c5
3 changed files with 12 additions and 0 deletions
@@ -18,3 +18,15 @@ Options:
  --help                    Show this message and exit.
 ````

+# Installation
+
+At the moment the easiest is in a conda environment with the necessary requirements (numpy, plotly, nicegui, plotext). In the future we will pack this additionally into a binary using pyinstaller.
+
+# Screenshots
+Everyone loves pictures, so here is the terminal interface:
+
+![terminal](terminal_interface.png)
+
+and from the web interface:
+
+![web](web_interface.png)