summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdrian Thurston <thurston@colm.net>2021-12-24 00:02:57 +0000
committerAdrian Thurston <thurston@colm.net>2021-12-24 00:09:23 +0000
commit8db7079040e96058678e3b7efba29a2565152654 (patch)
treed76df4e156accab898a18972e39270e6499b4705
parent69c077bc5cb649293c198593f6ac20cb922cfab4 (diff)
downloadragel-8db7079040e96058678e3b7efba29a2565152654.tar.gz
updated the README to reflect that we are no longer merged with colm
refs #79
-rw-r--r--README46
1 files changed, 9 insertions, 37 deletions
diff --git a/README b/README
index f7e8f64e..775cd185 100644
--- a/README
+++ b/README
@@ -1,51 +1,23 @@
- Colm.Net Suite of Programs
- ==========================
-
-This package contains the Colm Programming Language, Ragel State Machine
-Compiler 7.0+, and supporting libraries.
+ Ragel State Machine Compiler
+ ============================
DEPENDENCIES
============
-This package has no external dependencies, other than usual autotools and C/C++
-compiler programs.
-
-For the program:
-
- make libtool gcc g++ autoconf automake
-
-For the docucumentation:
-
- * asciidoc
- * fig2dev
+* 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
BUILDING
========
-Colm is built in the usual autotool way:
+Ragel is built in the usual autotools way:
$ ./autogen
-$ ./configure
+$ ./configure --prefix=$PREFIX --with-colm=$COLM_INSTALL_PATH
$ make
$ make install
-RUN-TIME DEPENDENCIES
-=====================
-
-The colm program depends on GCC at runtime. It produces a C program as output,
-then compiles and links it with a runtime library. The compiled program depends
-on the colm library.
-
-Notes on RUNNING
-================
-
-To find the includes and the runtime library to pass to GCC, colm looks at
-argv[0] to decide if it is running out of the source tree. If it is, then the
-compile and link flags are derived from argv[0]. Otherwise, it uses the install
-location (prefix) to construct the flags.
-
-SYNTAX HIGHLIGHTING
-===================
-
-There are vim syntax definition files colm.vim and ragel.vim
+Consult the Dockerfile for an example of building colm and ragel.