From c22e45aa3515be4070e3cf2a13ef758f71e7839d Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Tue, 29 Apr 2014 08:28:27 +0200 Subject: Add standard root files (README, INSTALL, etc) --- INSTALL | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ INSTALL-GIT | 79 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ NEWS | 3 +++ README | 20 ++++++++++++++ 4 files changed, 188 insertions(+) create mode 100644 INSTALL create mode 100644 INSTALL-GIT create mode 100644 NEWS create mode 100644 README diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..d23e70b --- /dev/null +++ b/INSTALL @@ -0,0 +1,86 @@ +Building on UNIX +================ + +The following build instructions are for the Linux/UNIX/Mac OS X +operating systems as well as for Cygwin and MinGW on Windows. + +The standard autotools-based build system is used on these platforms. After +unpacking the source code archive, change to the libstudxml package directory +(referred to as libstudxml/ from now on) and run the configure script: + +./configure + +To see the available configuration options run configure with --help: + +./configure --help + +As an example, the following configure command only builds shared libraries, +uses the specified C++ compiler, and compiles with optimization and without +debug information: + +./configure --disable-static CXX=g++-4.9 CXXFLAGS=-O3 + +One configure option worth mentioning is --with-extern-expat. It makes +libstudxml use an external Expat library rather than bulding-in the +internal version. + +Once configuration is complete, run make to build libstudxml: + +make + +Once the build is completed successfully you can run the tests using +the check target: + +make check + +You can also install the libstudxml headers and libraries using the +install target (you may need to do this step as root depending on the +installation directory): + +make install + + +Building on Windows +=================== + +The following build instructions are for Windows using Microsoft Visual +Studio. If you would like to build libstudxml with GCC either using Cygwin +or MinGW, refer to the "Building on UNIX" section above. + +The standard Visual Studio project and solution files are used on this +platform. To build the libstudxml library, unpack the source code archive +and open the libstudxml-vc.sln file located in the libstudxml package +directory (referred to as libstudxml\ from now on). Here is the version +of Visual Studio that you are using. Once the solution is open, select +the desired build configuration (Debug or Release) and platform (Win32 +or x64) and build the solution. + +The resulting 32-bit DLLs and import libraries are placed into the +libstudxml\bin\ and libstudxml\lib\ directories, respectively. Similarly, +the 64-bit DLLs and import libraries are placed into libstudxml\bin64\ +and libstudxml\lib64\. The Release versions of the import libraries are +named studxml.lib and the Debug versions are named studxml-d.lib. + +To configure Visual Studio to automatically locate the libstudxml headers, +DLLs, and import libraries, add the following paths to your VC++ +Directories: + +Win32: + + Include: ...\libstudxml + Library: ...\libstudxml\lib + Executable: ...\libstudxml\bin + +x64: + + Include: ...\libstudxml + Library: ...\libstudxml\lib64 + Executable: ...\libstudxml\bin64 + +If you would like to build the libstudxml examples, also open and build +the solution in the examples/ subdirectory. Similarly, to built the tests, +open and build the solution in the tests/ subdirectory. + +While you can run the tests and examples manually, it is also possible +to run all the tests and all the examples automatically using the test.bat +batch files located in the examples\ and tests\ directories. diff --git a/INSTALL-GIT b/INSTALL-GIT new file mode 100644 index 0000000..2c66aa0 --- /dev/null +++ b/INSTALL-GIT @@ -0,0 +1,79 @@ +The following instructions describe how to work with the source code that was +checked out from the git repository. + +The major difference between using a released source code package and source +code from the repository is that the former does not contain autotools-based +makefiles or Visual Studio project files. Instead, it contains templates for +these files as well as its own, custom build system. This build system is +used for development as well as to automatically generate the autotools and +Visual Studio files. + +This file describes how to use this build system to build the package as well +as to create a release-ready source distribution which contains the autotools +build system and Visual Studio project files. + + +Prerequisites +============= + +You will need the following additional packages to build from the git +repository: + + - GNU bash >= 2.0.0 http://www.gnu.org/software/bash/ + - GNU make >= 3.81 http://www.gnu.org/software/make/ + - build >= latest http://www.codesynthesis.com/projects/build/ + +If you are planning to create the source code distributions, then you will +also need the following packages: + + - GNU m4 >= 1.4.0 http://www.gnu.org/software/m4/ + - GNU sed >= 4.0.0 http://www.gnu.org/software/sed/ + - tofrodos >= 1.7.0 http://www.thefreecountry.com/tofrodos/ + +As we as the GNU autotools: + + - GNU libtool >= 2.2.6b http://www.gnu.org/software/libtool/ + - GNU autoconf >= 2.67 http://www.gnu.org/software/autoconf/ + - GNU automake >= 1.11.1 http://www.gnu.org/software/automake/ + +Any reasonably up to date GNU/Linux installation would normally have all of +the above packages already present, except for build and maybe tofrodos. + + +Configuring and Building +======================== + +To build the source code simply run make in the root directory of the package. +The first time you run make, the build process will also configure the +package by asking you several questions. On the subsequent runs, make will +only rebuild what has changed. + +To run the automated test suite, run 'make test'. To clean the object files, +executables, etc., run 'make clean'. To de-configure the package (that is, +to remove configuration files in addition to objects, executables, etc.), +run 'make disfigure'. + + +Creating Distribution +===================== + +To create the source code distribution, use the dist make target as well as +the dist_prefix variable to specify the directory where the distribution files +should be placed. For example: + +make dist dist_prefix=/tmp/libstudxml-1.0.0 + +Once the distribution files are ready, change to the distribution directory +and run the bootstrap script to bootstrap the autotools build system, for +example: + +cd /tmp/libstudxml-1.0.0 +./bootsrap + +To create the source code archives, use the autotools build system. First +configuring the package (see the INSTALL file for more information on this +step) and then use the dist (or distcheck) target to make the archives, for +example: + +./configure +make dist diff --git a/NEWS b/NEWS new file mode 100644 index 0000000..d59d7cb --- /dev/null +++ b/NEWS @@ -0,0 +1,3 @@ +Version 1.0.0 + + * Initial release. diff --git a/README b/README new file mode 100644 index 0000000..b751142 --- /dev/null +++ b/README @@ -0,0 +1,20 @@ +libstudxml is a C++ XML library. It provides parsing and serialization +APIs that were specifically designed for C++ and based on typical C++ +application needs when it comes to XML. For more information see: + +http://www.codesynthesis.com/projects/libstudxml/ + +See the NEWS file for the user-visible changes from the previous release. + +See the LICENSE file for distribution conditions. + +See the INSTALL file for prerequisites and installation instructions. + +See the doc/ directory for the API documentation. + +See the examples/ directory for examples. + +See the tests/ directory for the test suite. + +Send questions, bug reports, or any other feedback to the +studxml-users@codesynthesis.com mailing list. -- cgit v1.1