summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakob Kaivo <jkk@ung.org>2022-04-25 19:50:44 -0400
committerJakob Kaivo <jkk@ung.org>2022-04-25 19:50:44 -0400
commit1e43a21402f8868adbf5303c9f12d93e98f4f078 (patch)
treed0b61692ecb4c80d539afe495ee903a6b7e7bf64
parent319c7568828a01fa5ba8ded0b560d852124ffb84 (diff)
document flag support
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5b8d8b2..4db8cff 100644
--- a/README.md
+++ b/README.md
@@ -44,3 +44,19 @@ Or:
mkdir ../build
cd ../build
make -f ${OLDPWD}/Makefile SRCDIR=${OLDPWD}
+
+
+Setting Flags
+=============
+
+Maje recognizes some flags in source code that can be automatically added into
+the resulting Makefile. The following, followed by an equal sign, are copied
+up to the first white space character as indicated:
+
+ MAJE_CFLAG Added to the CFLAGS macro
+ MAJE_LDFLAG Added to the LDFLAGS macro
+ MAJE_LDLIB Added to the LDLIBS macro
+
+Maje will find these strings anywhere in your source file, so long as they
+are followed by an equal sign, one or more characters, and a whitespace
+character. Comments are a good place for them.