updated docs
diff --git a/README.md b/README.md
index 474e300..0f2bfe4 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,8 @@
It is modeled after [**Catch**](https://github.com/philsquared/Catch) which is currently the most popular alternative for testing in C++ - check out [**the differences**](doc/markdown/faq.md#how-is-doctest-different-from-catch).
+---------
+
There are many C++ testing frameworks - [Catch](https://github.com/philsquared/Catch), [Boost.Test](http://www.boost.org/doc/libs/1_60_0/libs/test/doc/html/index.html), [UnitTest++](https://github.com/unittest-cpp/unittest-cpp), [cpputest](https://github.com/cpputest/cpputest), [googletest](https://github.com/google/googletest) and many [other](https://en.wikipedia.org/wiki/List_of_unit_testing_frameworks#C.2B.2B).
What makes **doctest** different is that it is ultra light on compile times (by [**orders of magnitude**](doc/markdown/benchmarks.md#cost-of-including-the-header)) and is unintrusive.
@@ -41,7 +43,7 @@
[](https://github.com/onqtam/doctest/releases)
[](https://raw.githubusercontent.com/onqtam/doctest/master/doctest/doctest.h)
[](https://gitter.im/onqtam/doctest?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[](http://melpon.org/wandbox/permlink/vj10RKPooyTzq0cF)
+[](http://melpon.org/wandbox/permlink/U5JN08TXgUF929jh)
| master branch | Linux/OSX [](https://travis-ci.org/onqtam/doctest) | Windows [](https://ci.appveyor.com/project/onqtam/doctest/branch/master) | [](https://coveralls.io/github/onqtam/doctest?branch=master) | [](https://scan.coverity.com/projects/onqtam-doctest) |
|----------------|-----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
@@ -64,13 +66,15 @@
Documentation
-------------
+Project:
+
- [Features and design goals](doc/markdown/features.md) - the complete list of features
- [Roadmap](doc/markdown/roadmap.md) - upcoming features
- [Benchmarks](doc/markdown/benchmarks.md) - compile-time supremacy
-- [Contributing](doc/markdown/contributing.md)
-- [Examples](examples)
+- [Contributing](doc/markdown/contributing.md) - how to make a proper pull request
+- [Changelog](CHANGELOG.md) - generated changelog based on closed issues/PRs
--------------
+Usage:
- [Tutorial](doc/markdown/tutorial.md) - make sure you have read it before the other parts of the documentation
- [Assertion macros](doc/markdown/assertions.md)
@@ -80,6 +84,7 @@
- [Configuration](doc/markdown/configuration.md)
- [String conversions](doc/markdown/stringification.md)
- [FAQ](doc/markdown/faq.md)
+- [Examples](examples)
Sponsors
--------
diff --git a/doc/html_generated/readme.html b/doc/html_generated/readme.html
index c0e0e79..0ccc25e 100644
--- a/doc/html_generated/readme.html
+++ b/doc/html_generated/readme.html
@@ -6,13 +6,14 @@
Reference
=======
+Project:
+
- [Features and design goals](features.html) - the complete list of features
- [Roadmap](roadmap.html) - upcoming features
- [Benchmarks](benchmarks.html) - compile time supremacy
-- [Contributing](contributing.html)
-- [Examples](../../examples)
+- [Contributing](contributing.html) - how to make a proper pull request
--------------
+Usage:
- [Tutorial](tutorial.html) - make sure you have read it before the other parts of the documentation
- [Assertion macros](assertions.html)
@@ -22,6 +23,7 @@
- [Configuration](configuration.html)
- [String conversions](stringification.html)
- [FAQ](faq.html)
+- [Examples](../../examples)
Support the development of the project with donations! There is a list of planned features which are all important and big - see the [**roadmap**](roadmap.html). I took a break from working in the industry to make open source software so every cent is a big deal.
diff --git a/doc/html_generated/roadmap.html b/doc/html_generated/roadmap.html
index 6ac427a..1c6dfaf 100644
--- a/doc/html_generated/roadmap.html
+++ b/doc/html_generated/roadmap.html
@@ -53,7 +53,7 @@
- https://msdn.microsoft.com/en-us/library/hh270865.aspx
- https://msdn.microsoft.com/en-us/library/hh598953.aspx
- also look into similar Xcode integration - https://github.com/philsquared/Catch/pull/454
-- matchers - should investigate what they are
+- matchers - should investigate what they are - look at google test and Catch
- generators? - look at Catch - and investigate what they are (also in [boost](http://www.boost.org/doc/libs/1_61_0/libs/test/doc/html/boost_test/tests_organization/test_cases/test_case_generation.html))
- mocking - investigate google mock assertion macros and interop with doctest (also [mockitopp](https://github.com/tpounds/mockitopp) and [trompeloeil](https://github.com/rollbear/trompeloeil)) - and write in FAQ
- look at property based testing (for example [rapidcheck](https://github.com/emil-e/rapidcheck)) - and write in FAQ
diff --git a/doc/markdown/readme.md b/doc/markdown/readme.md
index c79ccb1..da878c6 100644
--- a/doc/markdown/readme.md
+++ b/doc/markdown/readme.md
@@ -1,13 +1,14 @@
Reference
=======
+Project:
+
- [Features and design goals](features.md) - the complete list of features
- [Roadmap](roadmap.md) - upcoming features
- [Benchmarks](benchmarks.md) - compile time supremacy
-- [Contributing](contributing.md)
-- [Examples](../../examples)
+- [Contributing](contributing.md) - how to make a proper pull request
--------------
+Usage:
- [Tutorial](tutorial.md) - make sure you have read it before the other parts of the documentation
- [Assertion macros](assertions.md)
@@ -17,6 +18,7 @@
- [Configuration](configuration.md)
- [String conversions](stringification.md)
- [FAQ](faq.md)
+- [Examples](../../examples)
Support the development of the project with donations! There is a list of planned features which are all important and big - see the [**roadmap**](roadmap.md). I took a break from working in the industry to make open source software so every cent is a big deal.
diff --git a/doc/markdown/roadmap.md b/doc/markdown/roadmap.md
index c9cf09a..bced7ff 100644
--- a/doc/markdown/roadmap.md
+++ b/doc/markdown/roadmap.md
@@ -48,7 +48,7 @@
- https://msdn.microsoft.com/en-us/library/hh270865.aspx
- https://msdn.microsoft.com/en-us/library/hh598953.aspx
- also look into similar Xcode integration - https://github.com/philsquared/Catch/pull/454
-- matchers - should investigate what they are
+- matchers - should investigate what they are - look at google test and Catch
- generators? - look at Catch - and investigate what they are (also in [boost](http://www.boost.org/doc/libs/1_61_0/libs/test/doc/html/boost_test/tests_organization/test_cases/test_case_generation.html))
- mocking - investigate google mock assertion macros and interop with doctest (also [mockitopp](https://github.com/tpounds/mockitopp) and [trompeloeil](https://github.com/rollbear/trompeloeil)) - and write in FAQ
- look at property based testing (for example [rapidcheck](https://github.com/emil-e/rapidcheck)) - and write in FAQ
diff --git a/scripts/random_dev_notes.md b/scripts/random_dev_notes.md
index 940b0f9..8248ee9 100644
--- a/scripts/random_dev_notes.md
+++ b/scripts/random_dev_notes.md
@@ -2,6 +2,30 @@
+== where to post an article about it:
+
+http://www.methodsandtools.com/tools/tools.php
+https://accu.org/index.php/journals/2061
+http://www.codeproject.com
+
+https://www.google.nl/#newwindow=1&safe=off&q=websites+like+codeproject+for+c%2B%2B
+http://www.codeguru.com/
+
+
+
+== when making a new release:
+
+news.ycombinator.com
+isocpp.org
+reddit.com/r/cpp
+reddit.com/r/programming
+reddit.com/r/cplusplus
+reddit.com/r/coding
+reddit.com/r/gamedev
+reddit.com/r/coding
+reddit.com/r/coolgithubprojects
+reddit.com/r/opensource
+reddit.com/r/software
@@ -20,13 +44,6 @@
-
-
-
-
-
-
-
-how to deal with pull requests for the main branch instead of the dev branch
+== how to deal with pull requests for the main branch instead of the dev branch
- http://stackoverflow.com/questions/9135913/merge-pull-request-to-a-different-branch-than-default-in-github
- git fetch origin pull/ID/head:BRANCHNAME