From 446ae68f111f34c486d3774535c169b962f781a7 Mon Sep 17 00:00:00 2001 From: Paulo Santos Date: Fri, 4 Jul 2025 18:13:00 +0100 Subject: [PATCH 1/6] Updated README Setup Instructions --- .gitignore | 1 + README.md | 33 ++++++++++++++++++++++++++++----- 2 files changed, 29 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index dc4a7172..c5c2fd65 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,7 @@ spooned .springBeans .sts4-cache +.idea # Created by https://www.gitignore.io/api/git,java,maven,eclipse,windows diff --git a/README.md b/README.md index deff16f6..8107543d 100644 --- a/README.md +++ b/README.md @@ -24,12 +24,35 @@ You can find out more about LiquidJava in the following resources: * [VSCode plugin for LiquidJava](https://github.com/CatarinaGamboa/vscode-liquidjava) -## Setup the project +# Setup the project -1. Clone the repository; -2. Run `setup.sh`, some dependencies include using `Java 20` or newer and using `Maven`. -3. Open the project in your favorite IDE (we have used Eclipse and VSCode) -4. Use the `pom.xml` in the root directory (which your IDE may have renamed to`liquidjava-umbrella`) to compile and run the tests. +## Installation Steps + +1. Clone the repository: `git clone https://github.com/CatarinaGamboa/liquidjava.git`; +2. Build the project `mvn clean compile`; +3. Run tests to verify installation: `mvn test`; +4. If importing into an IDE, import the project as a Maven project using the root `pom.xml`. + +## Verify Installation + +To verify that everything is working correctly: + +1. **Build the verifier JAR**: + ```bash + mvn package + ``` + +2. **Run verification on examples**: + ```bash + java -jar liquidjava-verifier/target/liquidjava-verifier-5.2-SNAPSHOT.jar liquidjava-example/src/main/java/testSuite/CorrectSimpleAssignment.java + ``` + This should output: `Correct! Passed Verification.` + +3. **Test an error case**: + ```bash + java -jar liquidjava-verifier/target/liquidjava-verifier-5.2-SNAPSHOT.jar liquidjava-example/src/main/java/testSuite/ErrorSimpleAssignment.java + ``` + This should output an error message describing the refinement violation. ## Run verification From e13a546dc582dd871ae2d7c981d1f1d13104d319 Mon Sep 17 00:00:00 2001 From: Paulo Santos Date: Fri, 4 Jul 2025 18:18:00 +0100 Subject: [PATCH 2/6] Updated README to include Prerequisites --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 8107543d..d4a7a9b0 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,12 @@ You can find out more about LiquidJava in the following resources: # Setup the project +## Prerequisites +Before setting up LiquidJava, ensure you have the following installed: + +- Java 20 or newer - The project is configured to use Java 20; +- Maven 3.6+ - For building and dependency management. + ## Installation Steps 1. Clone the repository: `git clone https://github.com/CatarinaGamboa/liquidjava.git`; From 36dd83f74ff398bfdfc24a1da3ac789ddf048b2a Mon Sep 17 00:00:00 2001 From: Paulo Santos Date: Sun, 6 Jul 2025 20:16:45 +0100 Subject: [PATCH 3/6] Updated README installation instructions --- README.md | 27 ++++++++++++++------------- liquidjava-verifier/pom.xml | 3 +++ 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index d4a7a9b0..959dac70 100644 --- a/README.md +++ b/README.md @@ -35,29 +35,30 @@ Before setting up LiquidJava, ensure you have the following installed: ## Installation Steps 1. Clone the repository: `git clone https://github.com/CatarinaGamboa/liquidjava.git`; -2. Build the project `mvn clean compile`; +2. Build the project `mvn clean install`; 3. Run tests to verify installation: `mvn test`; 4. If importing into an IDE, import the project as a Maven project using the root `pom.xml`. ## Verify Installation -To verify that everything is working correctly: +To generate an executable to check your refinements using LiquidJava, do as follows:To verify that you can execute LiquidJava: +*Warning: Any change to LiquidJava requires rebuilding the jar.* -1. **Build the verifier JAR**: - ```bash - mvn package - ``` +1. **Build the jar**: +```bash +mvn package -Djar.finalName=liquidjava +``` 2. **Run verification on examples**: - ```bash - java -jar liquidjava-verifier/target/liquidjava-verifier-5.2-SNAPSHOT.jar liquidjava-example/src/main/java/testSuite/CorrectSimpleAssignment.java - ``` - This should output: `Correct! Passed Verification.` +```bash +java -jar liquidjava-verifier/target/liquidjava.jar liquidjava-example/src/main/java/testSuite/CorrectSimpleAssignment.java +``` + This should output: `Correct! Passed Verification`. 3. **Test an error case**: - ```bash - java -jar liquidjava-verifier/target/liquidjava-verifier-5.2-SNAPSHOT.jar liquidjava-example/src/main/java/testSuite/ErrorSimpleAssignment.java - ``` +```bash +java -jar liquidjava-verifier/target/liquidjava.jar liquidjava-example/src/main/java/testSuite/CorrectSimpleAssignment.java +``` This should output an error message describing the refinement violation. ## Run verification diff --git a/liquidjava-verifier/pom.xml b/liquidjava-verifier/pom.xml index bce34bba..21464fa3 100644 --- a/liquidjava-verifier/pom.xml +++ b/liquidjava-verifier/pom.xml @@ -17,6 +17,7 @@ jar + ${jar.finalName} net.revelc.code.formatter @@ -110,6 +111,8 @@ 3.8.0 3.1.2 + + ${project.artifactId}-${project.version} From 387ee9b3f94c50a5faeb2e62d5a62b8ba9728f25 Mon Sep 17 00:00:00 2001 From: Paulo Santos Date: Sun, 6 Jul 2025 20:17:53 +0100 Subject: [PATCH 4/6] Fixed typo --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 959dac70..9be65e60 100644 --- a/README.md +++ b/README.md @@ -41,13 +41,14 @@ Before setting up LiquidJava, ensure you have the following installed: ## Verify Installation -To generate an executable to check your refinements using LiquidJava, do as follows:To verify that you can execute LiquidJava: -*Warning: Any change to LiquidJava requires rebuilding the jar.* +To generate an executable to check your refinements using LiquidJava*: 1. **Build the jar**: ```bash mvn package -Djar.finalName=liquidjava ``` +*Warning: Any change to LiquidJava requires rebuilding the jar.* + 2. **Run verification on examples**: ```bash From 374552afb2bb4f7521256bde56c9c3b5b356b04b Mon Sep 17 00:00:00 2001 From: Paulo Santos Date: Sun, 6 Jul 2025 20:32:51 +0100 Subject: [PATCH 5/6] Updated to use mvn --- README.md | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9be65e60..d2b66c20 100644 --- a/README.md +++ b/README.md @@ -41,24 +41,17 @@ Before setting up LiquidJava, ensure you have the following installed: ## Verify Installation -To generate an executable to check your refinements using LiquidJava*: - -1. **Build the jar**: -```bash -mvn package -Djar.finalName=liquidjava -``` -*Warning: Any change to LiquidJava requires rebuilding the jar.* - +To check your refinements using LiquidJava: 2. **Run verification on examples**: ```bash -java -jar liquidjava-verifier/target/liquidjava.jar liquidjava-example/src/main/java/testSuite/CorrectSimpleAssignment.java +mvn exec:java -pl liquidjava-verifier -Dexec.mainClass="liquidjava.api.CommandLineLauncher" -Dexec.args="liquidjava-example/src/main/java/testSuite/CorrectSimpleAssignment.java" ``` This should output: `Correct! Passed Verification`. 3. **Test an error case**: ```bash -java -jar liquidjava-verifier/target/liquidjava.jar liquidjava-example/src/main/java/testSuite/CorrectSimpleAssignment.java +mvn exec:java -pl liquidjava-verifier -Dexec.mainClass="liquidjava.api.CommandLineLauncher" -Dexec.args="liquidjava-example/src/main/java/testSuite/ErrorSimpleAssignment.java" ``` This should output an error message describing the refinement violation. From 619d286e3eb38dcc0f784804055171c6a0d3f9e9 Mon Sep 17 00:00:00 2001 From: Paulo Santos Date: Sun, 6 Jul 2025 22:03:59 +0100 Subject: [PATCH 6/6] Updated README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d2b66c20..922ce221 100644 --- a/README.md +++ b/README.md @@ -43,13 +43,13 @@ Before setting up LiquidJava, ensure you have the following installed: To check your refinements using LiquidJava: -2. **Run verification on examples**: +**Run verification on examples**: ```bash mvn exec:java -pl liquidjava-verifier -Dexec.mainClass="liquidjava.api.CommandLineLauncher" -Dexec.args="liquidjava-example/src/main/java/testSuite/CorrectSimpleAssignment.java" ``` This should output: `Correct! Passed Verification`. -3. **Test an error case**: +**Test an error case**: ```bash mvn exec:java -pl liquidjava-verifier -Dexec.mainClass="liquidjava.api.CommandLineLauncher" -Dexec.args="liquidjava-example/src/main/java/testSuite/ErrorSimpleAssignment.java" ```