From ded5432b23889b3ee19140f27ece44f6c590cf1d Mon Sep 17 00:00:00 2001 From: dgelessus <dgelessus@users.noreply.github.com> Date: Wed, 5 Jul 2023 18:25:34 +0200 Subject: [PATCH] Update README.md --- README.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2882f98..4a771a2 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,28 @@ # Camille + The Camille Editor for Rodin. -[](https://travis-ci.org/hhu-stups/camille) +[](https://gitlab.cs.uni-duesseldorf.de/general/stups/camille) + +## Installing + +In Rodin, go to Help > Install New Software... and select the Camille update site. +The update site should be preconfigured in Rodin - if not, add it using the URL https://stups.hhu-hosting.de/rodin/camille/release/. ## Building Camille -Maven 3 is required to build the project: - <pre> - cd org.eventb.texteditor.parent - mvn clean verify - </pre> + +Building the project requires Java 11 or later (tested with Java 17) and Maven 3.6.3 or later (tested with Maven 3.9). +(At runtime, the plugin is still compatible with Java 8.) + +```sh +$ cd org.eventb.texteditor.parent +$ mvn clean verify +``` -This will produce an updatesite in org.eventb.texteditor.repository/target +This will produce a p2 repository (update site) in org.eventb.texteditor.repository/target/repository -We autmatically produce nightly builds that can be installed using the update site located at https://stups.hhu-hosting.de/rodin/camille/nightly/ +We autmatically produce nightly builds that can be installed using the repository located at https://stups.hhu-hosting.de/rodin/camille/develop/. ## Contributing/Bugs -Pull requests are very welcome. Suggestions for new extensions and known bugs are tracked on [Github](https://github.com/hhu-stups/camille/issues) +Pull requests are very welcome. Suggestions for new extensions and known bugs are tracked on [GitHub](https://github.com/hhu-stups/camille/issues). -- GitLab