]> git.zndr.dk Git - unittest.git/commitdiff
README.md edited online with Bitbucket
authorJannik Zander <jannikz@gmail.com>
Fri, 10 Feb 2017 16:14:58 +0000 (16:14 +0000)
committerJannik Zander <jannikz@gmail.com>
Fri, 10 Feb 2017 16:14:58 +0000 (16:14 +0000)
README.md

index d27ae1bb1d76129944fd5849d08e1e550b24d720..8b0a535146d514c9344eddba33fd32c64fa73251 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,15 +7,18 @@ This is a framework for doing unit testing with CMake.
 ## Setup steps for Windows \r
 * Install Visual Studio 2008\r
 * Install CMake \r
-  * Make sure executable is added to environmant path.\r
+  * Make sure executable is added to environment path\r
 * Install CPPUnit\r
-  * Make sure the environment variable CPPUNITDIR is pointing to your installation folder\r
+  * Make sure the environment variable CPPUNITDIR is pointing to your installation folder\r
   * Make sure CPPUnit is compiled with same compiler as is used to testing (MSVC 2008)\r
 \r
 Some additional notes\r
+\r
 * Visual Studio 2013 can also be used (or any other C++ compiler that is installed on your PC)\r
 * The framework support both CPPUnit testing framework and google testing framework\r
-* 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:\r
+* If google testing framework is selected it will be git cloned automatically if it is not found on your PC. \r
+This has the added advantages:\r
+\r
   * Easy to swap between compilers since it is build automatically\r
   * No installation of testing framework is required beforehand\r
 \r
@@ -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".\r
 \r
 Each "unit" of code has a name and the following properties:\r
+\r
 *  What source files should be included in this "unit"\r
 *  Which public interface or include path we need for this "unit"\r
 *  Which other "units" this "unit" depends on\r
@@ -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. \r
 \r
 Each user of a "unit" can be kept unaware of that\r
+\r
 * You decide to re-arrange your "unit" e.g split a .c file pair into two file pairs\r
 * You add/remove dependencies to other "units"\r
 \r