Extend documentation of the editor (#75)

* Extend documentation of the editor * Apply suggestions from code review Co-authored-by: Daniil Palagin <[email protected]> * Update README.md --------- Co-authored-by: Daniil Palagin <[email protected]>
kbss-cvut · Nov 5, 2024 · 65e1977 · 65e1977
1 parent 01c4cc8
commit 65e1977
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,19 @@
 # SPipes Editor UI
 
+SPipes Editor UI is editor of [SPipes](https://github.com/kbss-cvut/s-pipes) scripts with following features:
+- script visualization
+  - browse the related filesystem structure where the scripts are stored
+  - represent pipelines as interactive graphs
+  - collapse/expand groups of nodes based on the source file
+  - automatically layout graph nodes
+- script modification
+  - receive notifications if a script file changes outside the editor
+  - use custom editors for specific modules (e.g., an SPARQL query editor)
+  - directly edit .ttl files using a built-in editor
+-  script execution
+  - execute scripts with specified parameters
+  - browse the history of previous executions
+
 We will use `$PROJECT_ROOT` as the root directory of this project, i.e., the directory where this README is located. Similarly, we will define:
 - `$SPIPES_EDITOR_ROOT` -- root folder of cloned repository [s-pipes-editor](https://github.com/kbss-cvut/s-pipes-editor)
 - `$SPIPES_MODULES_ROOT` -- root folder of cloned repository [s-pipes-modules](https://github.com/blcham/s-pipes-modules)