Add short description here
Project description
Welcome to My C++ Project
Prerequisites
Building My C++ Project requires the following software installed:
- A C++11-compliant compiler
- CMake
>= 3.9
- Doxygen (optional, documentation building is skipped if missing)
- The testing framework Catch2 for building the test suite* Python
>= 3.8
for building Python bindings
Building My C++ Project
The following sequence of commands builds My C++ Project. It assumes that your current working directory is the top-level directory of the freshly cloned repository:
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build .
The build process can be customized with the following CMake variables,
which can be set by adding -D<var>={ON, OFF}
to the cmake
call:
BUILD_TESTING
: Enable building of the test suite (default:ON
)BUILD_DOCS
: Enable building the documentation (default:ON
)BUILD_PYTHON
: Enable building the Python bindings (default:ON
)
If you wish to build and install the project as a Python project without
having access to C++ build artifacts like libraries and executables, you
can do so using pip
from the root directory:
python -m pip install .
Testing My C++ Project
When built according to the above explanation (with -DBUILD_TESTING=ON
),
the C++ test suite of My C++ Project
can be run using
ctest
from the build directory:
cd build
ctest
The Python test suite can be run by first pip
-installing the Python package
and then running pytest
from the top-level directory:
python -m pip install .
pytest
Documentation
My C++ Project provides a Sphinx-based documentation, that can be browsed online at readthedocs.org. To build it locally, first ensure the requirements are installed by running this command from the top-level source directory:
pip install -r doc/requirements.txt
Then build the sphinx documentation from the top-level build directory:
cmake --build . --target sphinx-doc
The web documentation can then be browsed by opening doc/sphinx/index.html
in your browser.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for testghacookiecutter-0.0.81-cp310-cp310-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b87360cc190d4c2415958af4d60c1f0a002569fbb7887e1eefe027aeefc99640 |
|
MD5 | 31fb982d16406eb67132e8a1720cc272 |
|
BLAKE2b-256 | 80d9e73b7f662c2790018a6240280caeb44b01f5ebcb15ecd2b7cd7a6175c4b8 |
Hashes for testghacookiecutter-0.0.81-cp310-cp310-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f48c2c545732912a54fff4dbcd9a4a945b30614e3347de57f1d9bd1ee583246 |
|
MD5 | 946ca8375f7937b1a76915f5aa57ea42 |
|
BLAKE2b-256 | 1bac7f22094c56633ac730e57aaeab11034019ea00e99eaeef456869ae7586ac |
Hashes for testghacookiecutter-0.0.81-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0763d4f36a513cb3067a5344bdfe165619c735af1f02558d55572df56188a036 |
|
MD5 | 003b5daeeb952d4a8ebd960588b3c8fd |
|
BLAKE2b-256 | caa3cf5db3e838a924c6d7209711c134b366041abdf3e5e80c54e98ce8848989 |
Hashes for testghacookiecutter-0.0.81-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a992a08dc27cff1cedcd046448e13ea947fb107c789c5016a02e756478c3281 |
|
MD5 | 5f2b3527c72b006d33f3112aa19108d3 |
|
BLAKE2b-256 | cce83469d6d22e4d5c6de97ed99205252913d843a91cc81a1eb008b0e1bea6ac |
Hashes for testghacookiecutter-0.0.81-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f4a19a299450f3566395332f3caea796ea30b00ee642a5b04d65a65fe0e22d5 |
|
MD5 | 66759ff175f2f668f497a5611dabdc3c |
|
BLAKE2b-256 | 3c783cd750f2b5d852fb3bd5e3bf0b9a8863edeadb7be826b0fc7a8f62c099ba |
Hashes for testghacookiecutter-0.0.81-cp39-cp39-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 49926484749cbf621a01d71c90c58c0388ad9b7e1a90c65e9204d51b93e19bbf |
|
MD5 | 25740b0ea8e588e3c17039760caf02c9 |
|
BLAKE2b-256 | 0a52d31d89c0839a642b40bdd4f5263297084d4e337cbb10a99d4bd41dd697bd |
Hashes for testghacookiecutter-0.0.81-cp39-cp39-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dda4008d561bae1a6f529e5e92c1041a92129dbb6a46994056688fb4ea9d4e65 |
|
MD5 | a803db9c7af6dd3c04ccf4b82576ff57 |
|
BLAKE2b-256 | b8d270bd37a2a25874ec7833db6bd0dff4c07635717f84b31658fd4b0d9cc839 |
Hashes for testghacookiecutter-0.0.81-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea4d433858147d23c1d68287feb49d17fb6bd6352eb5820348c87359f1e75aea |
|
MD5 | 4862814f5b483377d15c570290e1e3a1 |
|
BLAKE2b-256 | 88917a29d5b1349ebf8065a34dfb4006211fd71f006ec57a1b5a91c412e35353 |
Hashes for testghacookiecutter-0.0.81-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea939c6ecb4c5e58a9e77cab46aba5a6d366cebd655b3f4d4eaac4549c1601ec |
|
MD5 | 5342c8a8a82c454e9506b1aae69d7fae |
|
BLAKE2b-256 | 5fa268eb61ec5b1f324dd27a2f47da600c10a9cb28faef9643695a4f4b1d95e3 |
Hashes for testghacookiecutter-0.0.81-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 941035c986ed8862b49c4d6db68bd64be74557a84124b84cd25ba3e37909b6e7 |
|
MD5 | 4465500009da2f88ea18215a5714a2a4 |
|
BLAKE2b-256 | c0127d348b7dad29b058416718c9290b7400b51c66958de68a0e951600d09969 |
Hashes for testghacookiecutter-0.0.81-cp38-cp38-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0351a8d18c8df6e94daf1e701bb1556b5c428e01ba186f55745d9b39df9ea9f |
|
MD5 | c717d816d08095a06ecc1ac1cd255cac |
|
BLAKE2b-256 | 8d811ea5593a9b11f3d353632485175ef44717198cffe09bc9172015059b6afe |
Hashes for testghacookiecutter-0.0.81-cp38-cp38-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27bb894447535a19f52dc93b7aefa3a331d727e83bda2085b98ab66481d5556c |
|
MD5 | 03f744d8ad819a52eabeb77735c7f24b |
|
BLAKE2b-256 | 923be70b5d1165dfc99a60edb7064f8ec137c2f08b6bb1b24b6b2cba7a16dc76 |
Hashes for testghacookiecutter-0.0.81-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2ffe25247447ae95d6afb215fc51becbdcc4e6449346c450c100fbced525642 |
|
MD5 | 2bc07af96b9616777b80fdf1933a281c |
|
BLAKE2b-256 | dc223a453852f5b07135e154add555bf87c62e546b49cd88806a5917450684cf |
Hashes for testghacookiecutter-0.0.81-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9df79c89b624f70fac26c59d921a09f219f3d85aad873bc05321a8fb79f229c6 |
|
MD5 | 6b2bab77d38d68e5df801c8c0e7f62e9 |
|
BLAKE2b-256 | 4a2ab901728e9607d7d41ab2bd4bc58df9f5efd6d8300ae5afe365019b5386b6 |
Hashes for testghacookiecutter-0.0.81-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 511826224762b21a263375fd216076f70e551ad1c31a223dac160f0573f5e025 |
|
MD5 | 26b7bc0d1f0efb6d34d7b759c3215f89 |
|
BLAKE2b-256 | b3c37086dd3d60fde5e9eb01de57187e853603d97373b4cecb0e7296297761d7 |