diff options
| author | Adrian Thurston <thurston@colm.net> | 2017-01-06 16:20:21 -0330 |
|---|---|---|
| committer | Adrian Thurston <thurston@colm.net> | 2017-01-06 16:20:21 -0330 |
| commit | b7299da129362a2b226d6dc2fb5ce820bee07041 (patch) | |
| tree | 675a877b115a189e2718ec74f0c2fbd4a0cec815 /README | |
| parent | 34dd8467a4b29a9243c093c8cdf95a799e3f3055 (diff) | |
| download | ragel-b7299da129362a2b226d6dc2fb5ce820bee07041.tar.gz | |
updated README to reflect build and run-time dependencies
Diffstat (limited to 'README')
| -rw-r--r-- | README | 31 |
1 files changed, 23 insertions, 8 deletions
@@ -1,7 +1,25 @@ SUPPORTED ON ============ -Colm is supported on Unix-like systems. It depends on GCC at runtime. +Colm is supported on Unix-like systems. + +RUN-TIME DEPENDENCIES +===================== + +Colm 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. + +BUILD DEPENDENCIES +================== + +For the program: + + make libtool gcc g++ autoconf automake + +For the docucumentation: + + asciidoc BUILDING ======== @@ -16,13 +34,10 @@ $ make install Notes on RUNNING ================ -Colm produces a C program as output, then compiles and links it with a runtime -library. It will leave the C program behind as an artefact. - -To find the includes and the runtime library, colm looks at argv[0] to decide -if it is running out of the source tree. If it is, then compile and link flags -are derived from argv[0]. Otherwise, it uses the install location (prefix) to -construct the flags. +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 =================== |