Start tracking XSD/e dependency information with git

1 files changed, 54 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..8b00f95
--- /dev/null
+++ b/README
@@ -0,0 +1,54 @@
+This archive contains pre-configured CodeSynthesis XSD/e source code 
+with all its dependencies (except Xerces-C++ and Boost) as well as a
+build script that builds the XSD/e compiler in non-interactive mode
+(that is, without asking any questions).
+
+The following GNU tools are required to build XSD/e. Any fairly recent 
+GNU/Linux distribution should have these already installed:
+
+GNU bash >= 2.00   (bash --version)  http://www.gnu.org/software/bash/
+GNU m4   >= 1.4    (m4 --version)    http://www.gnu.org/software/m4/
+GNU make >= 3.81   (make --version)  http://www.gnu.org/software/make/
+GNU g++  >= 3.4.3  (g++ --version)   http://gcc.gnu.org/
+
+The build script expects you to have the Xerces-C++ (2.6.0 or later)
+as well as Boost filesystem and regex (1.33.1 or later) libraries
+built and installed in a location where the g++ compiler looks by
+default (normally /usr/lib/ and /usr/local/lib/). Alternatively, you
+can install them into the stage/ directory in this package or provide
+include (-I) and library (-L) paths via the CPPFLAGS and LDFLAGS
+variables, respectively.
+
+The script supports the following standard variables:
+
+CXX        (defaults to g++ if not set)
+CPPFLAGS
+CXXFLAGS
+LDFALGS
+LIBS
+MAKEFLAGS
+
+For example:
+
+$ CXX=g++-4.2 CXXFLAGS=-O3 MAKEFLAGS=-j4 ./build.sh
+
+If you would like to see the full compiler/linker/etc., command lines,
+you can add verbose=1 to MAKEFLAGS, for example:
+
+MAKEFLAGS="verbose=1" ./build.sh
+
+After the build, the XSD/e compiler can be found in the xsde-x.y.z/xsde/
+directory. You can also create a distribution package with the XSD/e 
+compiler binary, source code and build system for the runtime library
+and examples, as well as the documentation using the dist target, for
+example:
+
+$ ./build.sh dist
+
+The distribution files are placed into the dist/xsde-x.y.z/ directory. The
+build script also supports the clean target:
+
+$ ./build.sh clean
+
+Send bug reports or any other feedback to the xsde-users@codesynthesis.com
+mailing list.