Skip to content

Commit 36dd83f

Browse files
committed
Updated README installation instructions
1 parent e13a546 commit 36dd83f

File tree

2 files changed

+17
-13
lines changed

2 files changed

+17
-13
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -35,29 +35,30 @@ Before setting up LiquidJava, ensure you have the following installed:
3535
## Installation Steps
3636

3737
1. Clone the repository: `git clone https://github.com/CatarinaGamboa/liquidjava.git`;
38-
2. Build the project `mvn clean compile`;
38+
2. Build the project `mvn clean install`;
3939
3. Run tests to verify installation: `mvn test`;
4040
4. If importing into an IDE, import the project as a Maven project using the root `pom.xml`.
4141

4242
## Verify Installation
4343

44-
To verify that everything is working correctly:
44+
To generate an executable to check your refinements using LiquidJava, do as follows:To verify that you can execute LiquidJava:
45+
*Warning: Any change to LiquidJava requires rebuilding the jar.*
4546

46-
1. **Build the verifier JAR**:
47-
```bash
48-
mvn package
49-
```
47+
1. **Build the jar**:
48+
```bash
49+
mvn package -Djar.finalName=liquidjava
50+
```
5051

5152
2. **Run verification on examples**:
52-
```bash
53-
java -jar liquidjava-verifier/target/liquidjava-verifier-5.2-SNAPSHOT.jar liquidjava-example/src/main/java/testSuite/CorrectSimpleAssignment.java
54-
```
55-
This should output: `Correct! Passed Verification.`
53+
```bash
54+
java -jar liquidjava-verifier/target/liquidjava.jar liquidjava-example/src/main/java/testSuite/CorrectSimpleAssignment.java
55+
```
56+
This should output: `Correct! Passed Verification`.
5657

5758
3. **Test an error case**:
58-
```bash
59-
java -jar liquidjava-verifier/target/liquidjava-verifier-5.2-SNAPSHOT.jar liquidjava-example/src/main/java/testSuite/ErrorSimpleAssignment.java
60-
```
59+
```bash
60+
java -jar liquidjava-verifier/target/liquidjava.jar liquidjava-example/src/main/java/testSuite/CorrectSimpleAssignment.java
61+
```
6162
This should output an error message describing the refinement violation.
6263

6364
## Run verification

liquidjava-verifier/pom.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
<packaging>jar</packaging>
1818

1919
<build>
20+
<finalName>${jar.finalName}</finalName>
2021
<plugins>
2122
<plugin>
2223
<groupId>net.revelc.code.formatter</groupId>
@@ -110,6 +111,8 @@
110111
<!-- plugin versions -->
111112
<pVersion.compiler>3.8.0</pVersion.compiler>
112113
<pVersion.surefire>3.1.2</pVersion.surefire>
114+
<!-- name of the generated plugin -->
115+
<jar.finalName>${project.artifactId}-${project.version}</jar.finalName>
113116
</properties>
114117

115118
<repositories>

0 commit comments

Comments
 (0)