Update the documentation

sensity-ai · Jul 3, 2023 · 5a55319 · 5a55319
1 parent be2be93
commit 5a55319
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -119,6 +119,23 @@ pip install -e .
 
 ### Running dot
 
+#### Graphical interface
+
+To use the graphical interface of dot run
+
+```bash
+conda activate dot
+python ./src/dot/ui/ui.py
+```
+
+Watch the following demo video for better understanding of the interface
+
+<p align="center">
+<img src="./assets/gui_dot_demo.gif" width="500" height="406"/>
+</p>
+
+#### CLI
+
 Run `dot --help` to get a full list of available options.
 
 1. Simswap

diff --git a/assets/gui_dot_demo.gif b/assets/gui_dot_demo.gif