summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorMatthias Braun <matze@braunis.de>2015-12-29 23:22:38 +0100
committerMatthias Braun <matze@braunis.de>2015-12-29 23:22:38 +0100
commit39e6402f25c9ea2a507c9cc826133d90f3138aba (patch)
tree64149e839f35ed68ace3ab42349f05fc69ba67b2 /README.md
parent9ed9540a4ad91e505209084f5e5d3c43ced74dfb (diff)
README: Cleanup, add build section
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 23 insertions, 6 deletions
diff --git a/README.md b/README.md
index d4304b8..2a6d2f5 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
cparser - A C99 parser (with gnu extensions)
============================================
-1. Introduction
----------------
+Introduction
+------------
cparser is a recursive descent C99 parser written in C99. It contains
preprocessor, lexer, parser, constructs an AST and does semantic analysis. It
@@ -12,16 +12,33 @@ commandline to setup the environment and code generator and calling assemblers
and linkers. This allows it to be a drop-in replacement for gcc or clang in
many situations.
-2. Building and Installation
-----------------------------
+Building and Installation
+-------------------------
Requirements:
* A C99 compiler (gcc and icc are known to work).
* libFirm-1.22
-3. Further Information and Contact
-----------------------------------
+### Building with make
+
+Unpack libfirm in a directory called libfirm in the source directory
+alternatively you may setup an alternate location with a 'config.mak' file.
+Just type 'make' in the source directory. The results are put into a directory
+called "build". You can override the existing preprocessor, compiler and linker
+flags and built-in paths for include directories by creating a 'config.mak'
+file.
+
+### Building with cmake
+
+cparser has an additional cmake build system. CMake is a complexer build system
+than the make based build and most cparser developers do not use it. However
+it can adapt the compiler and linker flags to build shared libraries for a
+wider range of systems, provides an installation target and is often more
+familiar for people preparing packages for distribution.
+
+Further Information and Contact
+-------------------------------
Official website: http://libfirm.org/