Skip to content

Commit 446ae68

Browse files
committed
Updated README Setup Instructions
1 parent f8a0315 commit 446ae68

File tree

2 files changed

+29
-5
lines changed

2 files changed

+29
-5
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ spooned
1010
.springBeans
1111
.sts4-cache
1212

13+
.idea
1314

1415
# Created by https://www.gitignore.io/api/git,java,maven,eclipse,windows
1516

README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,35 @@ You can find out more about LiquidJava in the following resources:
2424
* [VSCode plugin for LiquidJava](https://github.com/CatarinaGamboa/vscode-liquidjava)
2525
<!-- * [Formalization of LiquidJava](https://github.com/CatarinaGamboa/liquidjava-formalization) - not opensource yet -->
2626

27-
## Setup the project
27+
# Setup the project
2828

29-
1. Clone the repository;
30-
2. Run `setup.sh`, some dependencies include using `Java 20` or newer and using `Maven`.
31-
3. Open the project in your favorite IDE (we have used Eclipse and VSCode)
32-
4. Use the `pom.xml` in the root directory (which your IDE may have renamed to`liquidjava-umbrella`) to compile and run the tests.
29+
## Installation Steps
30+
31+
1. Clone the repository: `git clone https://github.com/CatarinaGamboa/liquidjava.git`;
32+
2. Build the project `mvn clean compile`;
33+
3. Run tests to verify installation: `mvn test`;
34+
4. If importing into an IDE, import the project as a Maven project using the root `pom.xml`.
35+
36+
## Verify Installation
37+
38+
To verify that everything is working correctly:
39+
40+
1. **Build the verifier JAR**:
41+
```bash
42+
mvn package
43+
```
44+
45+
2. **Run verification on examples**:
46+
```bash
47+
java -jar liquidjava-verifier/target/liquidjava-verifier-5.2-SNAPSHOT.jar liquidjava-example/src/main/java/testSuite/CorrectSimpleAssignment.java
48+
```
49+
This should output: `Correct! Passed Verification.`
50+
51+
3. **Test an error case**:
52+
```bash
53+
java -jar liquidjava-verifier/target/liquidjava-verifier-5.2-SNAPSHOT.jar liquidjava-example/src/main/java/testSuite/ErrorSimpleAssignment.java
54+
```
55+
This should output an error message describing the refinement violation.
3356

3457
## Run verification
3558

0 commit comments

Comments
 (0)