aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README70
1 files changed, 70 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..6dcb3ba
--- /dev/null
+++ b/README
@@ -0,0 +1,70 @@
+This archive contains pre-configured CodeSynthesis XSD source code
+with all its dependencies (except Xerces-C++ and Boost) as well as
+a build script that builds the XSD compiler in non-interactive mode
+(that is, without asking any questions).
+
+The following GNU tools are required to build XSD. 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 compiler can be found in the stage/bin/
+directory and the runtime headers in the stage/include/xsd/
+directory. You can install the XSD compiler, runtime library, and
+documentation with the install target, for example:
+
+$ MAKEFLAGS="install_prefix=/usr" ./build.sh install
+
+You can fine-tune the installation locations with the following
+make variables (should be set in MAKEFLAGS):
+
+install_prefix default is /usr/local
+install_data_prefix default is install_prefix
+install_exec_prefix default is install_prefix
+
+install_bin_dir default is install_exec_prefix/bin
+install_sbin_dir default is install_exec_prefix/sbin
+install_lib_dir default is install_exec_prefix/lib
+
+install_data_dir default is install_data_prefix/share
+install_inc_dir default is install_data_prefix/include
+
+install_doc_dir default is install_data_dir/doc
+install_man_dir default is install_data_dir/man
+install_info_dir default is install_data_dir/info
+
+The build script also supports the clean target:
+
+$ ./build.sh clean
+
+Send bug reports or any other feedback to the xsd-users@codesynthesis.com
+mailing list.