Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend documentation of the editor #75

Merged
merged 3 commits into from
Nov 5, 2024
Merged

Extend documentation of the editor #75

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ad94b79
Extend documentation of the editor
blcham Nov 1, 2024
8ce13de
Apply suggestions from code review
blcham Nov 5, 2024
23f3303
Update README.md
blcham Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
Loading