Read Me

------ Code2Test version 0.1 ReadMe ------

--- Requirements ---
 * python 2.4 (should be installed on gentoo)
 * ctags (for code parsing)
 * pyQT (for GUIs)

under gentoo you can solve this by this line: emerge -v dev-util/ctags dev-python/PyQt

--- Installation ---
no need to install, just use this directory

--- usage ---
Command Line Options
 * code2test <directory with include files (*.hh)>
   o the result is written to $PWD/tests/unittests (the default dir is set by an entry in the config file) 

--- HOWTO to create unittests for your project ---
some examples
    * example #1: 
        cd /path/to/your/apps/your-app/
        ~/code2test/code2test.py src/server/
        ls tests/unittests/
        #the tests are now in the correct subfolder test/unittests of the actual working directory
    * in general:
          o cd to your project, so that tests/ is a subfolder of the actual directory
          o execute the script with the location of the project's header files
          o script outputs everything to tests/unittests/
          o fill the tests
          o include Makefile.am into the Build-Process 

--- usage (non-standard) ---
    * logfile is saved to ./c2t-log.txt
    * config-files are located in ./include/CodeToTest/configs
          o config.ini:
                + general options for the generation 
          o logging.ini:
                + options for the python-loggers

--- viewstorage ---
    (qt-gui tool to view the storage-file-content)
    (not relevant now, but later when refactoring is completed)
    * just use ./viewstorage.py tests/unittests/c2t-treeinfo.meta

--- Support & Contact ---
    * http://sourceforge.net/projects/code2test