aboutsummaryrefslogtreecommitdiff
path: root/tests/bytecode/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'tests/bytecode/README.md')
-rw-r--r--tests/bytecode/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/tests/bytecode/README.md b/tests/bytecode/README.md
new file mode 100644
index 000000000..e8778900b
--- /dev/null
+++ b/tests/bytecode/README.md
@@ -0,0 +1,12 @@
+This directory contains the framework and test files for testing the byte code
+output of the Micro Python compiler.
+
+You need to first build the 'cpy' executable in the directory micropython/unix-cpy/.
+This executable is a minimal version of Micro Python which compiles a single source
+file and outputs the corresponding byte code.
+
+The output of Micro Python is checked against CPython 3.3.
+
+To run the tests use:
+
+ ./run-tests