aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README37
1 files changed, 37 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..610fbe4
--- /dev/null
+++ b/README
@@ -0,0 +1,37 @@
+==========================================================================
+Modular C++ Build System Template
+==========================================================================
+# Author : Christopher Batten
+# Date : September 24, 2008
+# Version : (under version control)
+
+This is a template for the Modular C++ Build System. Please refer to the
+following documentation for more information on the build system:
+
+ - 'mcppbs-uguide.txt' : Modular C++ Build System User Guide
+ - 'utst/utst-uguide.txt' : Unit Testing Framework User Guide
+ - 'style-guide.txt' : C++ Coding Style Guide
+
+Developers should eventually replace this 'README' file with information
+on their new project. It is recommended that the new 'README' file keep
+pointers to the above documentation so that end-users can learn about
+the build system. You may also want to keep the version information
+around so that you know what version of the build system you are using.
+
+--------------------------------------------------------------------------
+Template Instantiation
+--------------------------------------------------------------------------
+
+ - Update project metadata (name, maintainer, etc) in 'configure.ac'
+ - Run 'autoconf && autoheader' in project's root directory
+ - Add subprojects and update the list in 'configure.ac'
+
+--------------------------------------------------------------------------
+Build Steps
+--------------------------------------------------------------------------
+
+ % mkdir build
+ % cd build
+ % ../configure
+ % make
+