summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorMatthias Braun <matze@braunis.de>2011-12-07 18:54:47 +0100
committerMatthias Braun <matze@braunis.de>2011-12-07 18:54:47 +0100
commite7ab3b569ccf736d9e51b7f793ec70840b34cfa9 (patch)
tree5445129cee098551094742ac7760bff5e7adf204 /README.md
parentb8d8a754fb9fdcaf565d833b4f3810a5d6247922 (diff)
update NEWS, README
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9397ab2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+cparser - A C99 parser (with gnu extensions)
+============================================
+
+1. Introduction
+---------------
+
+cparser is a recursive descent C99 parser written in C99. It contains lexer,
+parser, constructs an AST and does semantic analysis. It is currently used as
+a frontend to the libFirm intermediate representation, but can be used
+independently. cparser is able to bootstrap itself. It currently uses an
+external preprocessor.
+
+2. Building and Installation
+----------------------------
+
+Requirements:
+
+* A C99 compiler (gcc and icc are known to work).
+* pkg-config (recommended)
+* libFirm-1.12.1 or later
+
+Make sure you have installed libFirm and pkg-config can find the libfirm.pc
+files ("pkg-config --modversion libfirm" should work). Use (GNU)-make to build
+cparser.
+
+3. Contact
+----------
+
+There's a Bugtracker at http://pp.info.uni-karlsruhe.de/~firm/bugs
+You can contact me at matze@braunis.de
+You might also visit the #firm channel on irc.freenode.net