diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 12 insertions, 3 deletions
@@ -2,6 +2,11 @@ XSD is an XML Schema to C++ compiler. +NOTE: the steps described below are more appropriate for the development of +XSD as opposed to consumption. If you just want to use XSD, see [Installing +XSD with `build2`](https://codesynthesis.com/products/xsd/doc/install-build2.xhtml) +for the step by step instructions. + The development setup for XSD uses two configurations, for example: ``` @@ -18,9 +23,13 @@ bdep init @target -d libxsd -d libxsd-tests -d xsd-tests -d xsd-examples ``` -To generate the documentation in the `.ps` and `.pdf` formats, `html2ps` and -`ps2pdf14` programs are required (the latter is from `ghostscript`). A warning -is issued in the development mode if these programs are not available. +To generate the documentation in the `.ps` and `.pdf` formats, the `html2ps` +and `ps2pdf14` programs are required (the latter is from `ghostscript`). A +warning is issued in the development mode if these programs are not available. + +To generate the Doxygen documentation (in `libxsd`) the `doxygen` program is +required. Currently this functionality is only enabled if `libxsd` is +initialized with explicit `config.libxsd.doxygen=true`. To test installation of the XSD compiler, create a separate target configuration (it will automatically resolve any build-time dependencies from |