From 04bb63fd5ec285b38de88635985885d70460ba71 Mon Sep 17 00:00:00 2001
From: Peter Wu <lekensteyn@gmail.com>
Date: Sat, 26 Nov 2011 20:47:59 +0000
Subject: Add README for pp2cc

---
 README | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README

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
-- 
cgit v1.2.1