Docs/installing.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3   ========== INSTALLING  ===========
   4   -->
   5 <section id="installing">
   6   <title id="installing.title">Installing ROBODoc</title>
   7   <para>The easiest way to install ROBODoc is to use one of the
   8     packages.  There are package for RedHat, Debian, OSX, and a precompiled
   9     executable for Windows.</para>
  10   <para>You can also compile --- from the sources.  On a system
  11     with <command>autoconfig</command> it is as simple as:</para>
  12   <programlisting>
  13 ./configure
  14 make
  15 make install
  16 </programlisting>
  17   <para>This currently does not work with cygwin.</para>
  18   <para>Under Windows you can use one of the makefile. There is a makefile for Borland C, MINGW,
  19        and Cygwin.  For other compilers you might want to try  <filename>makefile.plain</filename>.
  20 </para>
  21   <para>For instance for cygwin goto <filename>Source</filename> and run:</para>
  22   <programlisting>
  23 make -f makefile.mingw-cygwin
  24 </programlisting>
  25   <para>To install <command>ROBODoc</command> put the generated executable somewhere in your path.</para>
  26   <para>You can test your executable, by going to the
  27        <filename>Examples/PerlExample</filename> directory in the
  28        archive, and running <command>robodoc</command>.
  29        This should create a directory
  30        called <filename>Doc</filename>.  In there you should now
  31        find a file called <filename>masterindex.html</filename>.
  32 </para>
  33 </section>