aboutsummaryrefslogtreecommitdiffstats
path: root/INSTALL
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2022-07-02 16:59:45 -0700
committerKaz Kylheku <kaz@kylheku.com>2022-07-02 16:59:45 -0700
commitda98d5314731206cd03038d589d10c5c32a0ce8c (patch)
tree4b7dd002a5edda8f2e6561c29bf6aee80a3e9303 /INSTALL
parent94ed05fe4df6a657884596bdabd03c7666a63de7 (diff)
downloadcppawk-da98d5314731206cd03038d589d10c5c32a0ce8c.tar.gz
cppawk-da98d5314731206cd03038d589d10c5c32a0ce8c.tar.bz2
cppawk-da98d5314731206cd03038d589d10c5c32a0ce8c.zip
Restructure cppawk installation.
cppawk now expects to be installed in some directory (typically "bin"), such that the include files are in a "share/cppawk/include" directory where "share" is a sibling of "bin". The git repository is restructured to match this shape; cppawk is moved into "bin", and the include files into "share/cppawk/include".
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL25
1 files changed, 17 insertions, 8 deletions
diff --git a/INSTALL b/INSTALL
index fa6bd43..6d10143 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,14 +1,23 @@
Installing cppawk
-----------------
-A cppawk installation consists of the cppawk script accompanied by
-the cppawk-include directory containing the cppawk headers.
-This directory is placed in the same directory as cppawk, side by side.
+A cppawk installation consists of the cppawk script accompanied by the
+an include directory containing the cppawk headers.
-For instance, /usr/local/bin/cppawk and /usr/local/bin/cppawk-include/.
+cppawk determines the directory in which it is located, calling that
+directory selfdir. Then it instructs the preprocessor to look for
+headers in $selfdir/../share/cppawk/include. For instance, if cppawk is
+installed as /usr/local/bin/cppawk, it expects its header library to be
+in the /usr/local/share/cppawk/include directory.
+
+Steps to install cppawk as /path/to/installation/cppawk/bin might be:
# root=/path/to/installation
-# install -d ${root}
-# install cppawk ${root}
-# cp -r cppawk-include ${root}
-# chmod -R a+rX,go-w ${root}
+# install -d ${root}/bin
+# install -d ${root}/share/cppawk/include
+# install cppawk ${root}/bin
+# install share/cppawk/include/*.h ${root}/share/cppawk/include
+
+Historic note: originally, cppawk expected the include direcgtory
+to be called cppawk-include, and to be located in the same directory
+as itself.