From b1dee397458222e50a85382c12920fbbde39073d Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Mon, 9 Jul 2012 22:38:30 -0500 Subject: [PATCH] Update: add readme file for generate.sh --- build/documents/readme | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 build/documents/readme diff --git a/build/documents/readme b/build/documents/readme new file mode 100644 index 0000000..7be94b4 --- /dev/null +++ b/build/documents/readme @@ -0,0 +1,34 @@ +This package provides a _very_ primitive build system using a bash script called generate.sh. + +The syntax for generate.sh is: + generate.sh [options] + - where command is one of the following: 'build' or 'clean'. + - No 'install' command is provided, all of the files to install may be found in the build/ directory after the build command is executed. + - To install, simply copy the files in the build directory to their appropriate destination. + +Build Example: + ./generate.sh build + +Install Example: + cp -vR build/includes/* /usr/include/ + cp -vR build/libaries/* /usr/lib/ + cp -vR build/programs/* /usr/bin/ + cp -vR build/settings/* /etc/ + +If one of the build sub-directories, such as includes, libraries, programs, and settings, is empty or missing after a successfull build, then there are no files of that type to install. + +Build Tree Structure Example (using the return_code-0.3.0 project): + build/ + |-- includes + | `-- level_3 + | `-- return_code.h + |-- libraries + | |-- libreturn_code.so -> libreturn_code.so.0 + | |-- libreturn_code.so.0 -> libreturn_code.so.0.3.0 + | `-- libreturn_code.so.0.3.0 + |-- programs + | `-- return_code + `-- settings + + +See: data/build/dependencies for dependencies of this project. -- 1.8.3.1