simple-test Files

README

0) General information about the software package:
   simpletest is a simple and easy to use C++ code testing environment.

   The development goals are:
   -> Simple code structure
   -> Easy to use (less files, less includes, simple build environment integration)
   -> Useful examples
   -> Up-to-date documentation
   -> Available as source tarball and as Debian package

Project file structure:
[simpletest]
 |
 +-- [cmake] ... CMake script file directory
 |    +-- *.cmake ... script files used to manage the build and packaging process
 |
 +-- [deb-pkg] ... Debian packaging directory
 |    +-- simpletest-1.0.0-xxx.deb ... Debian installer package
 |    +-- [_CPack_Packages] ... CPack package build directory
 |
 +-- [doc] ... Doxygen documentation directory
 |    +-- [html] ... documentation directory, HTML version
 |    +-- [latex] ... documentation directory, LaTeX version
 |    +-- [custom] ... user-defined doxygen documentation directory
 |         +-- *.md ... user-defined documentation files (markdown format)
 |    +-- [cmake] ... directory for parsed *.cmake files
 |         +-- *.cmakedox ... parsed *.cmake files (doxygen format)
 |
 +-- [example] ... example code files
 |    +-- *.h ... example C++ header files
 |    +-- *.cpp ... example C++ source files
 |
 +-- [include] ... main include directory
 |    +-- *.h ... main C++ header files
 |
 +-- [resources] ... resource file directory
 |    +-- changelog ... Debian package changelog file
 |    +-- changelog.gz ... GnuZip compressed Debian package changelog file
 |    +-- copyright ... Debian package copyright file
 |    +-- license ... Debian package license file
 |    +-- readme ... Debian package readme file
 |
 +-- main.cpp ... main C++ program start routine
 |
 +-- Doxyfile ... doxygen configuration file
 |
 +-- SvnIgnore ... subversion ignore pattern file

1) Installation from source (tarball)
   Fetch archive file from online package archive
      $ wget https://sourceforge.net/simpletest/files/simpletest-1.0.0-Linux.tar.gz
      $ wget https://sourceforge.net/simpletest/files/simpletest-1.0.0-Linux.zip
   a) Extract the archive file to a directory of your choice
      $ tar -xzf simpletest-1.0.0-Linux.tar.gz
      $ unzip simpletest-1.0.0-Linux.zip
   b) Change to the source directory and build program
      $ cd /home/$USER/simpletest-1.0.0-Linux && make && make install
   c) The software is now installed in the following directories:
      -> headers ... /usr/include (or similar)
      -> binaries ... /usr/bin (or similar)
      -> libraries ... /usr/lib/simpletest (or similar)
      -> documentation ... /usr/share/doc/simpletest/{html|latex} (or similar)
      -> examples ... /usr/share/doc/simpletest/example (or similar)
      -> resources ... /usr/share/doc/simpletest (or similar)
   d) To remove installation run build target 'uninstall'
      $ cd /home/$USER/simpletest && sudo make uninstall
   e) To recompile the doxygen documentation run build target 'doxy'
      $ cd /home/$USER/simpletest && make doxy
   f) Remove the complete installation in case of accidential file removal, etc.
      $ cd /home/$USER/simpletest && sudo make install && sudo make uninstall

2) Installation from Debian package (*.deb)
   Fetch Debian package file from online archive
      $ wget https://sourceforge.net/simpletest/files/simpletest-1.0.0-Linux.deb
   a) Install package with 'gdebi' or 'gdebi-gtk'
      $ sudo gdebi simpletest-1.0.0-Linux.deb
      $ sudo gdebi-gtk simpletest-1.0.0-Linux.deb
   b) Remove package with 'gdebi-gtk', 'aptitude' or 'synaptic'
      $ sudo gdebi-gtk simpletest-1.0.0-Linux.deb
      $ sudo aptitude (and search for package in installed packages list)
      $ sudo synaptic (and search for package in installed packages list)

3) Support
   a) Read the documentation installed in: /usr/share/doc/simpletest/html/index.html
   b) Examine the code examples installed in: /usr/share/doc/simpletest/example
   c) Ask the author for help. Email address is provided below.

4) Error reports, questions, feature requests
   a) Error reports. When reporting errors please provide the following informations:
      -> a brief error description (including cmake output and/or compiler output)
      -> a minimal working code example (a test header file) that produces that error
      -> if the error is due to files/directories not found, add the top-level project directory-tree
   b) Questions. Before asking questions please read the relevant parts of the code documentation.
   c) Feature requests. Always welcome!
      If feasible and/or admissible to this project i will incorporate them as soon as possible.

5) Authors
   a) Software authors (C++ code)
      -> Jakob Harden <office@jakobharden.at>
   b) Documentation authors (doxygen)
      -> Jakob Harden <office@jakobharden.at>
   c) Build environment (CMake scripts and configuration)
      -> Jakob Harden <office@jakobharden.at>
   d) Packaging environment (CPack configuration)
      -> Jakob Harden <office@jakobharden.at>

Written by CMake function 'cpm_create_install_readme'