1.1 --- a/README.txt Tue Jan 10 23:00:46 2017 +0100
1.2 +++ b/README.txt Wed Jan 11 00:49:04 2017 +0100
1.3 @@ -58,6 +58,42 @@
1.4 This employs a cross compiler targeting the mipsel (little-endian MIPS)
1.5 architecture running GNU/Linux.
1.6
1.7 +Test Suite
1.8 +==========
1.9 +
1.10 +A test suite is provided to exercise the toolchain and expose regressions.
1.11 +More information is available by running the test_all.sh script with the
1.12 +appropriate option:
1.13 +
1.14 +./test_all.sh --help
1.15 +
1.16 +Running it with the --build option should prove to be the most useful
1.17 +approach in testing code analysis and validating code generation.
1.18 +
1.19 +Source Code Overview
1.20 +====================
1.21 +
1.22 +The source files implementing the toolchain are found in the distribution
1.23 +directory with .py suffixes. The lplc tool is also found in the distribution
1.24 +directory.
1.25 +
1.26 +The following directories also contain source code employed by the toolchain:
1.27 +
1.28 +compiler - a modified version of the Python compiler package
1.29 +pyparser - a modified version of the PyPy parser package
1.30 +
1.31 +The following directories provide tests:
1.32 +
1.33 +internal_tests - a collection of tests exercising toolchain objects directly
1.34 +tests - individual test programs exercising the toolchain itself
1.35 +
1.36 +The toolchain relies on additional code when generating output programs:
1.37 +
1.38 +lib - the standard library for Lichen programs
1.39 +templates - runtime support libraries for generated programs
1.40 +
1.41 +Finally, a docs directory provides documentation about this project.
1.42 +
1.43 Contact, Copyright and Licence Information
1.44 ==========================================
1.45