From d730bf2cb526907d7615a0396b3a20c2b03ba219 Mon Sep 17 00:00:00 2001 From: Pedro Ribeiro Date: Sat, 25 May 2024 22:55:38 +0100 Subject: [PATCH] Updated README.md and GA workflow. --- .github/workflows/main.yml | 7 +++++++ README.md | 11 +++++++++-- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 9f88026..ff224d5 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -58,11 +58,18 @@ jobs: uses: softprops/action-gh-release@v2 with: body: | + RoboTool compiled and packaged as an Eclipse product using Eclipse tycho's Maven builder. + + Note that binaries are not signed. In particular, when downloaded and extracted under macOS may need [dequarantining](https://superuser.com/questions/526920/how-to-remove-quarantine-from-file-permissions-in-os-x) using the command `xattr -d com.apple.quarantine Eclipse.app` to avoid a message saying that the binary is damaged. +
+ Main feature versions + Feature | Version --------|-------- ${{ steps.versions.outputs.content }} --------|-------- +
files: | robotool-product/target/products/*.tar.gz diff --git a/README.md b/README.md index 43d57c1..384f1e5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,9 @@ -# robotool -Top-level repository for tracking issues and discussions about overall RoboTool. +# RoboTool +RoboTool supports graphical modelling, validation, and automatic generation of mathematical definitions for proof of properties of RoboChart models, with proof automated using model checking. The RoboChart notation is distinctive in its features that support architectural modelling as well as timed constructs in state machines. + +This repository provides a complete RoboTool install, both as a [setup file](RoboTool.setup) for installation using the Eclipse installer, as well as self-contained releases that can be executed directly after downloading. The latter contain a Java JRE for +the target platform. + +## Documentation +The [RoboTool manual](https://robostar.cs.york.ac.uk/publications/techreports/reports/robotool-manual.pdf) describes in detail +how to use the tool. Documentation for notations is available from the [RoboStar notations page](https://robostar.cs.york.ac.uk/notations/). \ No newline at end of file