summaryrefslogtreecommitdiff
path: root/src/README
diff options
context:
space:
mode:
authorAdrian Thurston <thurston@colm.net>2019-09-09 18:00:05 -0600
committerAdrian Thurston <thurston@colm.net>2019-09-09 18:07:40 -0600
commit6e379ead8f003650a162790b9f3a78fa5d7b22a6 (patch)
treebe5dcd5ac4629bdddec5ac0d0a459fbfaf439112 /src/README
parent3fef8c775492d6164aa67fac2d815e65285ee445 (diff)
downloadcolm-6e379ead8f003650a162790b9f3a78fa5d7b22a6.tar.gz
the config.h file now goes to src
Any piece of the system may need to use config.h. Put that in /src and add -Isrc to CPPFLAGS. The colm package uses defs.h for configuration. It gets installed because some public headers depend on it.
Diffstat (limited to 'src/README')
-rw-r--r--src/README6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/README b/src/README
new file mode 100644
index 00000000..70a21561
--- /dev/null
+++ b/src/README
@@ -0,0 +1,6 @@
+The /src directory just holds the config.h header for use by the various
+components. The source code is spread amongst these sub-projects:
+
+aapl - General Purpose Template Library.
+colm - Colm Programming Language.
+ragel - Ragel State Machine Compiler.