Extend README, add directories

jspam · Oct 29, 2014 · aaece04 · aaece04
1 parent 6ca38bc
commit aaece04
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,12 @@
 Come one, come all! Just create Pull Requests, we'll merge them.
 
+Directory layout
+
+ - Place *.mj files which are supposed to compile in pos/
+ - Place *.mj files which are not supposed to compile in neg/
+ - Place *.mj files which are intended to be compiled and executed,
+   and print values to stdout (via `System.out.println`).
+   Place a *.check file with the same name as the *.mj file to specify the expected output.
+
 List of tests/tools (please keep up to date):
 * `lexfuzz.py`: lexer fuzzer, prints string to be lexed to stdout, expected result (in --lextest format) to stderr.
diff --git a/neg/.keep b/neg/.keep
diff --git a/pos/.keep b/pos/.keep
diff --git a/run/.keep b/run/.keep