Skip to content

Updated README Setup Instructions #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pcanelas merged 6 commits into from
Jul 25, 2025
Merged

Updated README Setup Instructions #45

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
446ae68
Updated README Setup Instructions
pcanelas Jul 4, 2025
e13a546
Updated README to include Prerequisites
pcanelas Jul 4, 2025
36dd83f
Updated README installation instructions
pcanelas Jul 6, 2025
387ee9b
Fixed typo
pcanelas Jul 6, 2025
374552a
Updated to use mvn
pcanelas Jul 6, 2025
619d286
Updated README
pcanelas Jul 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 3 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**:
Copy link
Copy Markdown
Collaborator

@GUIpsp GUIpsp Jul 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2->1 and so forth

Doesn't really matter for the rendering, but you should still change it

```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.

Expand Down