################################################################################
###                          WHAT IS THIS                                    ###
################################################################################

This is a sample project demonstrating how to integrate sonar with
your code base 'by hand'.

It uses nothing but make for building and has a simple structure
consisting of following 'subsystems':

  - cli (=command line interface)
  - lib (=library)
  - tests (=unit tests)
  
The tests-subdir also contains a stripped down version of gtest and
also demostrates how to integrate this wonderfull unit test framework
with your code.

It assumes following software to be installed:
- gcc
- make
- java, sonar-scanner
- cppcheck
- valgrind
- Python, gcovr.py
- vera++, perl, vera++Report2checkstyleReport.perl

See the the Cxx-Plugin Wiki for some details on dependencies:
https://github.com/SonarOpenCommunity/sonar-cxx/wiki


################################################################################
###                              USAGE                                       ###
################################################################################

1) build the project with 'make'
2) analyse the project with 'make sonar'

cleanup with 'make clean'