Skip to content

Commit d6672a7

Browse files
committed
Update README
1 parent cc9bade commit d6672a7

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,6 @@ To run LiquidJava, use the Maven command below, replacing `/path/to/your/project
7878
```bash
7979
mvn exec:java -pl liquidjava-verifier -Dexec.mainClass="liquidjava.api.CommandLineLauncher" -Dexec.args="/path/to/your/project"
8080
```
81-
*Warning: Any change to LiquidJava requires rebuilding the jar.*
82-
8381

8482
If you're on Linux/macOS, you can use the `liquidjava` script (from the repository root) to simplify the process.
8583

@@ -105,10 +103,14 @@ The starter test file is `TestExamples.java`, which runs the test suite under th
105103

106104
The test suite considers test cases:
107105
1. Files that start with `Correct` or `Error` (e.g., `CorrectRecursion.java`)
108-
2. Packages or folders that contain the word `correct` or `error` (e.g., `arraylist_correct`)
106+
2. Directories that contain the word `correct` or `error` (e.g., `arraylist_correct`)
109107

110108
Therefore, the files and folders that do not follow this pattern are ignored.
111109

110+
For failing test cases, the expected error must be specified as follows:
111+
1. In singular test files, the expected error (title) should be written in the first line of the file as a comment
112+
2. In test directories, a `.expected` file should be included in that directory with the expected error (title)
113+
112114
## Project Structure
113115

114116
* **docs**: Contains documents used for the design of the language. This folder includes a [README](./docs/design/README.md) with the link to the full artifact used in the design process. It also contains initial documents used to prepare the design of the refinements language during its evaluation

0 commit comments

Comments
 (0)