docs: add ecalc selftest gif (#626)

README.md

@@ -84,6 +84,8 @@ ecalc selftest
 
 Please refer to [Docker Docs](https://docs.docker.com/) for details on how to use Docker.
 
+![ecalc-selftest](docs/gifs/selftest.gif)
+
 ### Create and run your first model
 
 Please refer to the https://equinor.github.io/ecalc/docs/about/modelling/setup/ on how to set up your own model

docs/gifs/README.md

@@ -0,0 +1,19 @@
+# How to generate eCalc CLI gifs for documentation
+
+Install `vhs` as per their [documentation](https://github.com/charmbracelet/vhs?tab=readme-ov-file#installation), then restart your shell.
+
+Create a venv and install `libecalc` in this directory.
+
+```sh
+python -m venv venv
+source venv/bin/activate
+pip install libecalc
+```
+
+The `.tape`-file is the script showing what will be run when creating the `.gif`.
+
+To generate a new `.gif`, run `vhs` with the desired `.tape` file.:
+
+```sh
+vhs selftest.tape
+```

docs/gifs/selftest.tape

@@ -0,0 +1,27 @@
+Output selftest.gif
+
+Set Framerate 60
+Set WindowBar Colorful
+Set BorderRadius 10
+Set Margin 20
+Set MarginFill "#181926"
+Set Theme "Catppuccin Macchiato"
+Set Width 1300
+Set Height 600
+Set Shell bash
+
+Hide
+Type@50ms "source venv/bin/activate; clear"
+Enter
+Show
+
+Type "ecalc --version"
+Sleep 0.5s
+Enter
+Sleep 5s
+
+Enter 2
+Type "ecalc selftest"
+Sleep 0.5s
+Enter
+Sleep 5s