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 1 commit
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:
- visualization of the scripts
blcham marked this conversation as resolved.
Show resolved Hide resolved
- exploration of the related filesystem structure where scripts are located
blcham marked this conversation as resolved.
Show resolved Hide resolved
- represent the pipelines as graphs
blcham marked this conversation as resolved.
Show resolved Hide resolved
- collapse/expand groups of nodes based on the source file they come from
blcham marked this conversation as resolved.
Show resolved Hide resolved
- automatic layout of graph nodes
blcham marked this conversation as resolved.
Show resolved Hide resolved
- modification of the scripts
blcham marked this conversation as resolved.
Show resolved Hide resolved
- notification if script file changes outside of the editor
blcham marked this conversation as resolved.
Show resolved Hide resolved
- custom editors for specific modules (e.g. SPARQL query editor)
blcham marked this conversation as resolved.
Show resolved Hide resolved
- editor to edit ttl directly
blcham marked this conversation as resolved.
Show resolved Hide resolved
- execution of the scripts
blcham marked this conversation as resolved.
Show resolved Hide resolved
- execute scripts with parameters
blcham marked this conversation as resolved.
Show resolved Hide resolved
- explore the history of executions
blcham marked this conversation as resolved.
Show resolved Hide resolved

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