Skip to content

Commit

Permalink
docs: extend README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DNKpp committed Jun 16, 2024
1 parent 47908b5 commit c2251f8
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The one thing, that this framework does different than all other (or at least al
thus directly callable. It's simple and straight forward.

As I'm mainly working on template or functional-style code, I wanted something simpler than always creating explicit mock types for the simplest of use cases.
So, ``mimicpp::Mock`` objects can directly used as functional objects, but they can also be used as member objects and thus serve as actual member functions.
So, ``mimicpp::Mock`` objects can directly be used as functional objects, but they can also be used as member objects and thus serve as actual member functions.
If you are curious, have a look at the documentation or directly into the examples.

### Special Acknowledgement
Expand All @@ -41,3 +41,41 @@ It's definitly not bad, but sometimwes feels a little bit dated and some macros
If you need a pre-c++20 mocking-framework, you should definitly give it a try.

Fun fact: ``mimic++`` uses ``trompeloeil`` for it's own test suite :D

## Documentation
The documenation is generated via ``doxygen``. Users can do this locally by enabling both, the ``MIMICPP_CONFIGURE_DOXYGEN`` and ``MIMICPP_CONFIGURE_DOXYGEN``,
cmake options and building the target ``mimicpp-generate-docs`` manually.

The documentation for the ``main`` branch is always available on the github pages; for the ``development`` branch it is also available on the ``dev-gh-pages`` branch,
but unfortunatly not directly viewable on the browser.
Every release has the generated documentation attached.

## Testing
``mimic++`` utilizes a strict testing policy, thus each official feature is well tested. The effect of those test-cases are always tracked by the extensive ci,
which checks the compilation success, test cases outcomes and coverage on dozens of different os, compiler and build configurations.

The coverage is generated via ``gcov`` and evaluated by
[codacy](https://app.codacy.com/gh/DNKpp/mimicpp/dashboard),
[codecov](https://app.codecov.io/gh/DNKpp/mimicpp) and
[coveralls](https://coveralls.io/github/DNKpp/mimicpp).

### Windows
| OS | Compiler | c++-20 | c++-23 |
|--------------|----------|:------:|:------:|
| Windows 2022 | msvc | x | x |
| Windows 2022 | clangCl | x | x |

### Linux
| Compiler | libstdc++ | libc++ | c++-20 | c++-23 |
|----------|:---------:|:------:|:------:|:------:|
| clang-17 | x | x | x | x |
| clang-18 | x | x | x | x |
| gcc-13 | x | - | x | x |
| gcc-14 | x | - | x | x |

### MacOs
| Compiler | libstdc++ | libc++ | c++-20 | c++-23 |
|-------------------|:---------:|:------:|:------:|:------:|
| AppleClang-17.0.6 | - | x | x | x |

As new compilers become available, they will be added to the workflow, but older compilers will probably never be supported.

0 comments on commit c2251f8

Please sign in to comment.