summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Wu <lekensteyn@gmail.com>2011-11-26 20:47:59 +0000
committerPeter Wu <lekensteyn@gmail.com>2011-11-26 20:47:59 +0000
commit04bb63fd5ec285b38de88635985885d70460ba71 (patch)
tree4d9571b924fcd2a6328bc18a3a64ba16c7bcda59
parent424646a2a6ed13fbefefeb5081f4802e8da55b3e (diff)
downloadpp2cc-04bb63fd5ec285b38de88635985885d70460ba71.tar.gz
Add README for pp2cc
-rw-r--r--README26
1 files changed, 26 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..1a4133d
--- /dev/null
+++ b/README
@@ -0,0 +1,26 @@
+pp2cc is a C compiler for the PP2 Practicum Processor. It generates assembly
+from C code. Currently, pp2cc is licensed under a proprietary license, but
+this may change in the future.
+
+Depedencies:
+
+- Python - http://python.org/download/
+- pycparser - http://code.google.com/p/pycparser/
+
+Python is often installed by default on Linux distributions. For Windows, you
+probably need to run the installer from the above link. Extract the pycparser
+ZIP file (see link above) and copy the pycparser subdirectory to the directory
+containing pp2cc.py. pp2cc is a console program, you need to open a terminal
+(or cmd on Windows) to see the output.
+
+Currently, no file is written. All errors and compiled code go to stdout. This
+will be fixed later.
+
+Usage (subject to change)
+=========================
+Compile a program:
+
+ python pp2cc.py file.c
+Show the syntax tree (debugging, will be removed):
+
+ python pp2cc.py file.c show