Overview

===============================================
cppbench: a lightweight C++ benchmark framework
===============================================

cppbench is a lightweight benchmark framework.  It's designed for directly
comparable benchmarks.

LICENSE
=======
Simplified BSD License

GETTING THE SOFTWARE
====================
To obtain cppbench, simply run:

    hg clone https://bitbucket.org/qbproger/cppbench
    
BUILDING
========

cmake is used to build the software.  Install cmake before continuing.
Version 2.8.3 was used during development, but older versions will likely
work also.  Just open the CMakeLists.txt file in the top-level directory
and click Configure.  It will ask you to choose a generator, which can be
makefiles or Visual Studio projects.  For the binaries path, I advice doing
an "out of source" build meaning set the binaries path to 
"(top-level directory)/build/".

Here are some variables that can be set through the CMake GUI:
CMAKE_BUILD_TYPE should be set to "Release" if you want a release build ("Debug"
    is the default)

BUILD_EXAMPLES should be set to On or Off depending on if you want to build the
    included examples.
    
When building the install project either through Visual Studio or "make install",
the script will put the result in the path CMAKE_INSTALL_PREFIX.

HELP
=====

Website: TODO

API: TODO
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.