Commit 3a47e3cd authored by Johannes Bechberger's avatar Johannes Bechberger Committed by GitHub

Update README.mdwn

parent a92b5d94
......@@ -3,13 +3,14 @@ MJTest
A test runner (and suite) for the MiniJava compiler (and its parts) written in the compiler lab of the KIT.
It's heavily inspired by Sisyphus (and uses some of its code)
It's heavily inspired by Sisyphus (and uses some of its code). See the `preproc` folder more information on the included preprocessor.
__Please contribute test cases.__
__Please contribute test cases and improve the existing ones.__
__Semantic test cases that are executable (and terminate) should be placed in the `exec` folder.__
__Semantic test cases that are executable (and terminate) should be placed in the `exec` folder or sub folder.__
__Exec test cases can now use the import statement to import other classes. See the exec test case folder and the `preproc` folder for more information__
__Exec test cases can now use the import statement to import other classes. See the exec test case folder and the preproc folder for more information__
*There's also some other additional code in this repo, that might provide fuzzing capabilities. Please consider contributing
such code as it probably helps the other teams (and could later be integrated into a bigger test suite).*
......@@ -21,9 +22,9 @@ The test cases are divided in 5 'modes':
them.
- __ast__: Test cases that check the generated ast by using the pretty printing functionality.
- __semantic__: Test cases that check semantic checking of MiniJava programs
- __exec__: Test cases that check the correct compilation of MiniJava programs.
- __exec__: Test cases that check the correct compilation and execution of MiniJava programs.
_Only the lexer, syntax, ast and semantic mode are currently usable, but the others will follow._
_Only the lexer, syntax, ast and semantic mode are currently usable, but the others will follow._
The test different test cases for each mode are located in a folder with the same name.
The default directory that contains all test folders is `tests`.
......@@ -97,7 +98,7 @@ Test types for the semantic mode
</tr>
</table>
__All semantic mode tests have to syntactically correct___
__All semantic mode tests have to be syntactically correct___
Test runner
......@@ -181,7 +182,11 @@ Contributions
-------------
__Please contribute to this test runner and the accompanied test cases.__
To add test cases just open a pull request. The test cases must have unique names (in each mode folder).
To add test cases just open a pull request.
The test cases must have unique names (in each mode folder) and can also be placed into sub folders.
All contributions are reviewed but should be accepted in general (even if this means that there are duplicate test cases).
Issues regarding tests, the test runner or the preprocessor are also appreciated.
Licence
-------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment