summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README39
1 files changed, 39 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..b3a67b4
--- /dev/null
+++ b/README
@@ -0,0 +1,39 @@
+
+ZUBR (Parser Generator)
+=======================
+
+ZUBR is an LALR(1) parser generator. It reads a grammar specification
+and produces C parser source. Input and output text files use UTF-8; text
+is represented internally by ZUBR as UCS-2 through LibMPUIO.
+
+For more information please read the doc/zubr.md file.
+
+
+Developer bootstrap
+-------------------
+
+A Git checkout may omit files that are regenerated mechanically, including
+`configure`, `Makefile.in`, Automake helper scripts, `config.h.in`, `aclocal.m4`.
+Regenerate them with:
+
+ ./bootstrap
+
+`./bootstrap --target-dest-dir=DIR` follows the ZUBR convention for using
+Autoconf macro/header directories from a target ROOTFS. Release archives
+remain self-contained and do not require bootstrap before `configure`.
+
+
+Build
+-----
+
+ZUBR uses Autoconf/Automake and obtains LibMPUIO compilation and linker
+flags from `mpuio-config`, following the conventions of LibMPU and LibMPUIO.
+No pkg-config or flex dependency is introduced.
+
+A normal build is:
+
+ ./configure --prefix=/usr --libdir=/usr/lib64
+ make
+ make install
+
+Enjoy.