From: Jannik Zander Date: Fri, 10 Feb 2017 16:14:58 +0000 (+0000) Subject: README.md edited online with Bitbucket X-Git-Url: https://git.zndr.dk/?a=commitdiff_plain;h=60457e192eb5510896b289fba72de23dac15d0f4;p=unittest.git README.md edited online with Bitbucket --- diff --git a/README.md b/README.md index d27ae1b..8b0a535 100644 --- a/README.md +++ b/README.md @@ -7,15 +7,18 @@ This is a framework for doing unit testing with CMake. ## Setup steps for Windows * Install Visual Studio 2008 * Install CMake - * Make sure executable is added to environmant path. + * Make sure executable is added to environment path * Install CPPUnit - * Make sure the environment variable CPPUNITDIR is pointing to your installation folder. + * Make sure the environment variable CPPUNITDIR is pointing to your installation folder * Make sure CPPUnit is compiled with same compiler as is used to testing (MSVC 2008) Some additional notes + * Visual Studio 2013 can also be used (or any other C++ compiler that is installed on your PC) * The framework support both CPPUnit testing framework and google testing framework -* If google testing framework is selected it will be git cloned automatically if it is not found on your PC. This has the added advantages: +* If google testing framework is selected it will be git cloned automatically if it is not found on your PC. +This has the added advantages: + * Easy to swap between compilers since it is build automatically * No installation of testing framework is required beforehand @@ -23,6 +26,7 @@ Some additional notes To setup testing you need to define a "unit" of code that shall be tested and a corresponding "unittest". Each "unit" of code has a name and the following properties: + * What source files should be included in this "unit" * Which public interface or include path we need for this "unit" * Which other "units" this "unit" depends on @@ -30,6 +34,7 @@ Each "unit" of code has a name and the following properties: A "unittest" of code has the same kind of properties. Each user of a "unit" can be kept unaware of that + * You decide to re-arrange your "unit" e.g split a .c file pair into two file pairs * You add/remove dependencies to other "units"