README.build.txt

   1
   2 Steps to build the generated source:
   3 ====================================
   4
   5   $  ./autogen.sh           :   generate configure script, run configure
   6   $  make                   :   build the source
   7   $  make install           :   install the build
   8   $  make doxygen-doc   :       generates the doxygen html documentation in doc/ directory
   9                             relative to current working directory
  10
  11 ( Note: The autogen.sh should be run only once, which generates the configure script and runs it too.
  12 Once you have the configure script generated, next time onwards you should run configure instead of autogen.sh.)
  13
  14 It is likely that, while experimenting the tool with XML-Schema, you edit the files like XML-Schema iteratively, and would want to see the build in action for each such edit.
  15 After every edit, you should run following commands in that order:
  16 ----------------------------------------------------------
  17   $  xsd2cpp XML-Schema outdir
  18   $  cd outdir
  19   $  run configure ( with your choice of options)
  20   $  make
  21   $  make install
  22 ----------------------------------------------------------
  23
  24 Please note, that the main.cpp if already present in the output path, is not overridden instead a file named "main.cpp.template" is written corresponding to the new invocation. This is so to preserve any user edits inside main.cpp over it's generated copy. The important thing to remember is that if an edit is made to the XML-Schema file, the main.cpp may need to get updated with  changes like renamed classes, new includes, choice of documentElement etc. A "make" in this case may fail on main.cpp. So please make sure to do following in such cases:
  25  * apply user edits(if any) from current main.cpp to main.cpp.template
  26  * rename main.cpp.template to main.cpp
  27  * then run "make"
  28
  29
  30
  31 The build is installed in the path depending on --prefix option specified to autogen.sh or configure.
  32 Note that in the absence of an explicit specification of --prefix option, the autogen.sh(generated by xsd2cpp) defaults the install path to a directory build/ relative to the directory of input XML-Schema file.
  33
  34 For the input XML-Schema file <name>.xsd, the build contains:
  35     * the data-binding+parser+writer library
  36     * header files to be used in user development sources consuming the abovestated library
  37     * there is a binary built with name <name>run
  38