Merge pull request #159 from banditcpp/fix-doc

Improve docs (fix links, fix typos, add screenshots)

docs/index.md

@@ -120,7 +120,7 @@ If you want to see if bandit works for your compiler, bandit is shipped with a
 cmake project for generating bandit's self tests. Let us know how it goes.
 
 If your compiler does not support the C++11 features required by Bandit, we
-suggest that you take a look at [Igloo](http://igloo-testing.org), which is
+suggest that you take a look at [Igloo](//iglootesting.wordpress.com/), which is
 built on the same philosophy but works without C++11.
 
 ## Online resources

docs/reference.md

@@ -14,7 +14,7 @@ int main(int argc, char* argv[]) {
 
 ## Assertions
 
-Bandit uses the [snowhouse](https://github.com/banditcpp/snowhouse#assertions)
+Bandit uses the [Snowhouse](//github.com/banditcpp/snowhouse#assertions)
 assertion library. Go there for references on how to write assertions.
 For regular use, you probably need `using namespace snowhouse;` in your
 `.cpp` files.

docs/releases.md

@@ -48,7 +48,7 @@ In the following, we list breaking changes per major release.
 * The option handling became stricter.
   Illegal option arguments like `--reporter=invalid` result in an error now.
 
-* The assertion framework Snowhouse v3.0.0 is used including all its breaking
+* The assertion framework Snowhouse v5.0.0 is used including all its breaking
   changes.
 
 * The `snowhouse` namespace is not used by default.

docs/runningtests.md

@@ -59,6 +59,8 @@ depending on whether it succeeds or not.
 
 This is the default.
 
+![Screenshot of dots reporter](images/reporter-dots.png)
+
 #### `--reporter=singleline`
 
 Reports the progress on a single line.
@@ -67,16 +69,22 @@ Updating counters of executed, failed and skipped tests.
 Very useful if you do not want to be bothered a lot by output
 of the testing framework.
 
+![Screenshot of singleline reporter](images/reporter-singleline.png)
+
 #### `--reporter=xunit`
 
 Reports the test results in a XML format supported by most
 continuous integration servers.
 
+![Screenshot of xunit reporter](images/reporter-xunit.png)
+
 #### `--reporter=spec`
 
 Reports the tests in a format similar to how they are
 written along with the status of each test.
 
+![Screenshot of spec reporter](images/reporter-spec.png)
+
 #### `--reporter=info`
 
 Reports the tests in an appealing form with a marker
@@ -86,7 +94,9 @@ for every relevant `it`. The marker says `[ TEST ]` when the test starts,
 summary.
 Skipped `describe()`s are not shown at all.
 This reporter is somewhat inspired by the
-[Google Test](https://github.com/google/googletest) framework.
+[Google Test](//github.com/google/googletest) framework.
+
+![Screenshot of info reporter](images/reporter-info.png)
 
 #### `--reporter=crash`
 
@@ -95,6 +105,8 @@ Very useful, for example, if you have a huge amount of tests and you are
 testing code that may crash, in a continuous integration system that sends
 you a mail with the last few lines of output.
 
+![Screenshot of crash reporter](images/reporter-crash.png)
+
 ### Formatters
 
 With the `--formatter=<formatter>` option you can specify how bandit reports
@@ -120,7 +132,7 @@ The Qt Creator formatter reports errors as
 file://<filename>:<line>: <error message>
 ```
 
-It enables hyperlink from the console ouptut to jump directly to the error.
+It enables a hyperlink from the console output to jump directly to the error.
 
 #### `--formatter=vs`
 

docs/writingtests.md

@@ -116,6 +116,6 @@ does not provide context logic.)
 
 ## Assertions
 
-Bandit uses the [snowhouse](https://github.com/banditcpp/snowhouse#assertions)
+Bandit uses the [Snowhouse](//github.com/banditcpp/snowhouse#assertions)
 assertion framework to verify that things work as expected. Snowhouse contains
 a lot of helpers aiming at creating readable tests.