Skip to content

Commit

Permalink
Update README instructions (Disclaimer)
Browse files Browse the repository at this point in the history
  • Loading branch information
aarkue committed May 8, 2024
1 parent 4d7d55e commit 2a004a4
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ Run `docker compose up --build` in the project root.


## Usage
__Note: These instructions might not be up-to-date with the newest version.__

In particular, in the new approach based on binding boxes, the need to manually add object variables globally is eliminated.
To see examples of the new constraints, try out the Auto-Discovery feature and inspect the generated constraint.


### Loading OCELs & Viewing OCEL info
When visiting the initial page of the tool, you can load an OCEL2 file by either choosing a custom OCEL2 file (XML/JSON) or selecting an OCEL2 file from the provided list (only available in the dev/docker setup and only if there are .json/.xml files in the `backend/data` folder).
If the OCEL was loaded successfully, you will automatically be forwarded to the OCEL info view.
Expand Down

0 comments on commit 2a004a4

Please sign in to comment.