-
Notifications
You must be signed in to change notification settings - Fork 35
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.
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
Merged
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
446ae68
Updated README Setup Instructions
pcanelas e13a546
Updated README to include Prerequisites
pcanelas 36dd83f
Updated README installation instructions
pcanelas 387ee9b
Fixed typo
pcanelas 374552a
Updated to use mvn
pcanelas 619d286
Updated README
pcanelas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,12 +24,41 @@ You can find out more about LiquidJava in the following resources: | |
| * [VSCode plugin for LiquidJava](https://github.com/CatarinaGamboa/vscode-liquidjava) | ||
| <!-- * [Formalization of LiquidJava](https://github.com/CatarinaGamboa/liquidjava-formalization) - not opensource yet --> | ||
|
|
||
| ## 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. | ||
| ## 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`; | ||
| 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 | ||
GUIpsp marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ``` | ||
| 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 | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.