| commit | 7cd2fabc778b9e7c968acfcd0f26a48e449c3f97 | [log] [tgz] |
|---|---|---|
| author | onqtam <vik.kirilov@gmail.com> | Tue May 16 00:51:47 2017 +0300 |
| committer | onqtam <vik.kirilov@gmail.com> | Tue May 16 00:51:47 2017 +0300 |
| tree | d3cbf3d2d4baec2be49254708b5a8dd99a391d07 | |
| parent | 8d95bb8404af13785ed89edd454fdd9d85cfa1cb [diff] |
fixing broken links and tiny mistakes in docs
- CONTRIBUTING.md[diff]
- doc/markdown/assertions.md[diff]
- doc/markdown/configuration.md[diff]
- doc/markdown/faq.md[diff]
- doc/markdown/features.md[diff]
- doc/markdown/tutorial.md[diff]
- .clang-format
- .gitattributes
- .gitignore
- .travis.yml
- CHANGELOG.md
- CMakeLists.txt
- CONTRIBUTING.md
- LICENSE.txt
- README.md
- appveyor.yml
- doc/
- doctest/
- examples/
- issue_template.md
- pull_request_template.md
- scripts/
This library is free, and will stay free but needs your support to sustain its development. There are lots of new features and maintenance to do. If you work for a company using doctest or have the means to do so, please consider financial support. Monthly donations via Patreon and one-offs via PayPal.
A complete example with a self-registering test that compiles to an executable looks like this:
doctest is a new C++ testing framework but is by far the fastest both in compile times (by orders of magnitude) and runtime compared to other feature-rich alternatives. It brings the ability of compiled languages such as D / Rust / Nim to have tests written directly in the production code by providing a fast, transparent and flexible test runner with a clean interface.
Tests can be considered a form of documentation and should be able to reside near the production code which they test.
doctest is modeled after Catch which is currently the most popular alternative for testing in C++ - check out the differences.
You can read more about it in the article of the february edition of ACCU Overload 2017.
Documentation
Project:
- Features and design goals - the complete list of features and rationale behind the design
- Roadmap - upcoming features
- Benchmarks - compile-time and runtime supremacy
- Contributing - how to make a proper pull request
- Changelog - generated changelog based on closed issues/PRs
Usage:
- Tutorial - make sure you have read it before the other parts of the documentation
- Assertion macros
- Test cases, subcases and test fixtures
- Parameterized test cases
- Command line
- Logging macros
main()entry point- Configuration
- String conversions
- FAQ
- Build systems
- Examples
Contributing
Support the development of the project with donations! There is a list of planned features which are all important and big - see the roadmap. I took a break from working in the industry to make open source software so every cent is a big deal.
If you work for a company using doctest or have the means to do so, please consider financial support.
Contributions in the form of issues and pull requests are welcome as well - check out the Contributing page.
Sponsors
Want to see your name or the name of your company here? Consider donating!
:zap: Rockstar sponsors :zap:
:gem: Gold sponsors :gem:
- Pascal Thomet
- Mario Kostadinov
:cake: Silver sponsors :cake:
- Dan Nissenbaum
:hamburger: Bronze sponsors :hamburger:
- Sebastien Feldis
- Zahari Karadzhov