Welcome to CppDoc
==================

To build CppDoc, you will need the following software:
    
    Subversion (svn), an open source version control system (the successor to cvs).  This can be
    found at http://subversion.tigris.org.

    (Windows) Microsoft Visual C++ 6.0.  Yes, this version is currently required, so hopefully you
    still have it installed (it works fine side-by-side with VS.NET).  If anyone wants to provide a
    VS.NET project, that would be great.   

    (linux) gcc


Checkout CppDoc from SVN
=========================

Check out the latest version of the source code.  To do this, run the command:

    svn checkout https://www.cppdoc.com/svn/cppdoc

After running this command, you should have a directory "cppdoc" which contains the current CppDoc
source.  If you ran this command in:

    /working

you should have the directory:

    /working/cppdoc

In the following steps, this is ${cppdoc.home}.


Build CppDoc
============

1. If necessary, update to the latest source code.  In ${cppdoc.home}, do this:

  svn update

2. In Microsoft Visual C++, open ${cppdoc.home}/src/cppdoc.dsw.

3. Build.  

    a. The very first time you do this, you should build all configurations of RichLib.  The best way to do this is through Build->Batch Build.  In the dialog, choose all the RichLib configurations and press Build.

    b. Choose and build the CppDoc project/configuration you want:

        Projects:
            - CppDoc: the GUI version of CppDoc.
            - cppdoc_cmd: the command-line version of CppDoc.
            - cppdoc_core: the core CppDoc library.  This is a .lib used by CppDoc and cppdoc_cmd.
            - cppdoc_standard: the standard documentation module (a .dll).
            - cppdoc_old: the old (1.x) documentation module (a dll).
            - RichLib: a library of utility classes.  Apologies for the cheesy name -- its old.  :)

        Configurations:
            - Release: the non-Unicode release version, which is currently on the website.
            - Debug: non-Unicode version, compiled with debug flags.
            - Release Unicode: the Unicode release version.  I'm trying to transition to this as a
              prerequisite for supporting international characters.  Eventually, this should be the
              version that goes out on the website.
            - Debug Unicode: the Unicode debug version.


To submit proposed code changes
===============================
If you've got some code changes to propose, simply make the changes in the source tree, try them out, and then execute the following command from the root of the tree:
  svn diff > patch.txt

Then, open a bug/feature (whichever is appropriate) at http://www.cppdoc.com/bugs, and attach the patch.