summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdrian Thurston <thurston@colm.net>2021-12-27 19:47:40 +0000
committerAdrian Thurston <thurston@colm.net>2021-12-27 19:48:16 +0000
commitd5d66f8a74ab83c5a6f1eb78172185fd30f6c783 (patch)
tree8ea58c21ec64547ec12eb9687e73f3986d7761a6
parentf48206f992852784093c851dc4fca337c7dbf65f (diff)
downloadragel-d5d66f8a74ab83c5a6f1eb78172185fd30f6c783.tar.gz
update the README to reference the new docker files
refs #79
-rw-r--r--README26
1 files changed, 17 insertions, 9 deletions
diff --git a/README b/README
index 775cd185..a9525db1 100644
--- a/README
+++ b/README
@@ -4,20 +4,28 @@
DEPENDENCIES
============
-* The Colm Programming Language. There is a specific version required,
- which is specified in configure.ac. See EXPECTED_COLM_VER.
-
-* autotools and C/C++ compilers:
- make libtool gcc g++ autoconf automake
+Ragel depends on the Colm Programming Language. For now, the two packages move
+in close lockstep. If building master of ragel, generally, the master branch of
+colm is required. For releases, the specific version of colm needed is in
+EXPECTED_COLM_VER in configure.ac.
BUILDING
========
-Ragel is built in the usual autotools way:
+Ragel is built with autotools. If building from revision control you need to
+run autogen.sh. Then you can configure and make.
-$ ./autogen
+$ ./autogen.sh
$ ./configure --prefix=$PREFIX --with-colm=$COLM_INSTALL_PATH
$ make
-$ make install
-Consult the Dockerfile for an example of building colm and ragel.
+There are three dockerfiles that demonstrate installing dependencies and
+building:
+
+* full.Dockerfile installs all dependencies, including testing dependencies,
+ builds master, and does full testing.
+
+* master.Dockerfile does a basic build from master without testing.
+
+* release.Dockerfile builds and installs the release tarballs.
+