Added build instructions for those wanting MakefileWorker.

jwgrenning · jwgrenning · commit 965b4dbccb89 · 2019-10-17T14:51:33.000-04:00
Including links TDD-EC Book, cpputest-starter-project, legacy recipe and install using git add submodule.

Fixed bug: Embedded link to cpputest-2.7dev
diff --git a/index.markdown b/index.markdown
@@ -11,19 +11,17 @@ CppUTest's core design principles are:
 
 * Simple in design and simple in use.
 * Portable to old and new platforms.
-* Build with Test-driven Development in mind
+* Build with Test-driven Development for Test-driven Developers.
 
-## Where to get CppUTest
+## Setting up CppUTest
 
-### James Grenning's cpputest-starter-project
+There are several ways to setup CppUTest.  One is to install via package management and the other is from source. The big difference is that from source you can use `MakefileWorker.mk`. MakefileWorker is not supported pre-packaged.  MakefileWorker does not require you to know a lot about `make` and makefiles to get started.
 
-An easy way to get started adding tests to your code is by using James' [cpputest-starter-project](https://github.com/jwgrenning/cpputest-starter-project).  You'll find CppUTest installation instructions along with your first test case, and some other example code.  DO NOT INSTALL CppUTest using the "Pre-packaged" options described here. The starter kit uses `MakefileWorker.mk`  (not supported pre-packeged) helping you get started without having to first learn `make`.
+An easy way to get your first test case running is to use James Grenning's [cpputest-starter-project](https://github.com/jwgrenning/cpputest-starter-project).  James is the author of [Test-Driven Development for Embedded C](https://wingman-sw.com/tddec).  You'll find instructions, your first test case, and some other example code.  James' training resources use MakefileWorker, so you need to install from source.
 
-James' example is set up to have you put CppUTest into your own git repo (as a submodule) so in the years to come, you can recreate your exact unit test environment.
+Adding tests to untested C and C++ can be a big challenge.  You might find [Get your Legacy C into a Test Harness](https://wingman-sw.com/articles/tdd-legacy-c) a useful recipe and resource. The page includes links to numerous articles of real legacy C challenges.
 
-Adding tests to untested C and C++ can be a big challenge.  You might find [TDD HOW-TO: Get your Legacy C into a Test Harness](https://wingman-sw.com/articles/tdd-legacy-c) a useful recipe and resource. The page includes links to numerous articles of real legacy C challenges.
-
-### Pre-packaged
+### Pre-packaged install
 
 *Linux*
 
@@ -41,11 +39,11 @@ For Mac, a Homebrew package is available too. You can install via:
 $ brew install cpputest
 {% endhighlight %}
 
-### From source
+### From source install
 
 You can download the latest 'automatically released' version:
 
-* [Latest version passing the build](https://github.com/cpputest/cpputest.github.io/blob/master/releases/cpputest-3.7dev.tar.gz?raw=true)
+* [Latest version passing the build](https://github.com/cpputest/cpputest.github.io/blob/master/releases/cpputest-3.8dev.tar.gz?raw=true)
 This version is automatically packages after a build has passed.
 
 Alternatively, you can clone the github repository, read-only:
@@ -60,7 +58,13 @@ Or clone it via ssh (which requires a github account)
 $ git clone git@github.com:cpputest/cpputest.git
 {% endhighlight %}
 
-After you have cloned CppUTest, you can build it with your favorite build tool (CMake or autoconf).
+CppUTest can also be added to your git repor as a git submodule
+
+{% highlight bash %}
+$ git submodule add https://github.com/cpputest/cpputest.git
+{% endhighlight %}
+
+Now that you have CppUTest sources, you can build it with your favorite build tool (CMake or autoconf).
 
 Building with autoconf requires you to (this requires you to have installed GNU autotools, apt-get/brew install automake autoconf libtool):
 
@@ -71,6 +75,24 @@ $ ../configure
 $ make
 {% endhighlight %}
 
+**NOTE**: Building from `cpputest_build` means you will not be able to use `MakefileWorker.mk`.  To use MakefileWorker you need to build from the cpputest home directory.
+
+### Using CppUTest with `MakefileWorker.mk` and gcc
+
+If you want to use CppUTest's `MakefileWorker.mk`, you cannot currently get CppUTest using the "Pre-packaged" options described above. Instead you can get CppUTest from source using the options already described.
+
+Change to the top level directory of CppUTest (the directory containing `include/` and `src/` among other files)
+
+{% highlight bash %}
+$ cd cpputest \
+$ autoreconf . -i
+$ ./configure
+$ make tdd
+$ export CPPUTEST_HOME=$(pwd).
+{% endhighlight %}
+
+You will want to add `export CPPUTEST_HOME=<path>` somewhere like `.bashrc` or in your build script as a relative path. 
+
 ## How to create a coverage report
 
 You can use autoconf to create a coverage report for CppUTests own tests. If you have lcov installed, a browsable html report will be generated as well. After the steps outlined in the previous paragraph, do the following:
