Skip to content

Commit 9c87c4b

Browse files
authored
Updated README Setup Instructions (#45)
* Updated README Setup Instructions * Updated README to include Prerequisites * Updated README installation instructions * Fixed typo * Updated to use mvn * Updated README
1 parent f8a0315 commit 9c87c4b

File tree

3 files changed

+33
-5
lines changed

3 files changed

+33
-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: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,36 @@ 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+
## Prerequisites
30+
Before setting up LiquidJava, ensure you have the following installed:
31+
32+
- Java 20 or newer - The project is configured to use Java 20;
33+
- Maven 3.6+ - For building and dependency management.
34+
35+
## Installation Steps
36+
37+
1. Clone the repository: `git clone https://github.com/CatarinaGamboa/liquidjava.git`;
38+
2. Build the project `mvn clean install`;
39+
3. Run tests to verify installation: `mvn test`;
40+
4. If importing into an IDE, import the project as a Maven project using the root `pom.xml`.
41+
42+
## Verify Installation
43+
44+
To check your refinements using LiquidJava:
45+
46+
**Run verification on examples**:
47+
```bash
48+
mvn exec:java -pl liquidjava-verifier -Dexec.mainClass="liquidjava.api.CommandLineLauncher" -Dexec.args="liquidjava-example/src/main/java/testSuite/CorrectSimpleAssignment.java"
49+
```
50+
This should output: `Correct! Passed Verification`.
51+
52+
**Test an error case**:
53+
```bash
54+
mvn exec:java -pl liquidjava-verifier -Dexec.mainClass="liquidjava.api.CommandLineLauncher" -Dexec.args="liquidjava-example/src/main/java/testSuite/ErrorSimpleAssignment.java"
55+
```
56+
This should output an error message describing the refinement violation.
3357

3458
## Run verification
3559

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)