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.89-cp310-cp310-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c2fcd87ef95a9d792897ee7b4e2f874555bb1f7d589b3af97017ccb8f45c672 |
|
MD5 | 0c0c8ec3ee0f52fc28be859e9b193c26 |
|
BLAKE2b-256 | b1c3038fe818f6bd427263a4a014e62de7a938aaad470167bbef4d841de130ff |
Hashes for testghacookiecutter-0.0.89-cp310-cp310-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f88095e3c5701c9b9ca6b856c179e41d40fc2516976c1213c3e829916f23e5aa |
|
MD5 | bf388628e4f321ba2ba4c22e947cc101 |
|
BLAKE2b-256 | a5f6ec971223c9271baa98087deb68b6dd47c7b2990ce324cb96d55b311dd6cf |
Hashes for testghacookiecutter-0.0.89-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c9d25e9c0fe2692a092c23d10fd5f7361d0dddcb191cc8598c9d3a4ac47ffa4 |
|
MD5 | c41bf4b568e2a82188f1cf098d71e3e0 |
|
BLAKE2b-256 | eb317d773f2e1663adde579ee4e22ba64ef3b88836746e54b95aad6b79c0552e |
Hashes for testghacookiecutter-0.0.89-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a06fd8e13c2e43b89fa61a39e9df6f1511df6f7777476abb2c5212f2bc63b53a |
|
MD5 | 03e6261338abd15b938fa399f1a21f02 |
|
BLAKE2b-256 | d45dadc087b8a74e6f2ec62f66455a6abb8b475621fb97b82d6c63ef7d4bf269 |
Hashes for testghacookiecutter-0.0.89-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4015b456f66f1bd6c7609c1e1de155dd0b9d4cd3b1ee9422885d0043297615eb |
|
MD5 | c0f696340eb509daebcee70b68f96c71 |
|
BLAKE2b-256 | 850e935f316234fd353045361a28c31eaabdf2f06c78974668c90c127ce4ac95 |
Hashes for testghacookiecutter-0.0.89-cp39-cp39-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09e7833e67da33d4cbdbe8d0fe35d4424a225431af4a1f45dac9b57becd9c0a8 |
|
MD5 | e8540f36da3ba8366aee9f12d5433250 |
|
BLAKE2b-256 | d8c3c61eeecb087f05d67117cccf638a2c8e3082c830c2e547dfa9d18d09c5fb |
Hashes for testghacookiecutter-0.0.89-cp39-cp39-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8598d181c57f538a4580404d0fc2852d257e8977ed8551a9752e794117e30812 |
|
MD5 | f0039a88469f1a02ad4cf29c036abb98 |
|
BLAKE2b-256 | 70064e63ddc75517b31fb730d0a206fe77e882cfe7585810a07d2f963c47e648 |
Hashes for testghacookiecutter-0.0.89-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8ea540fa617c94f67af1ec62f5f4809ba226b56910d0cdf148f93f21d1e07880 |
|
MD5 | b4bb51d0a945dc28656aeafe58aaae5e |
|
BLAKE2b-256 | f64e5229bd70c4751795016eb750c8b2440577c73d23d92166ce51a78549e049 |
Hashes for testghacookiecutter-0.0.89-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd8fcc72f19dad94c36703616cd3e409a800a6c50129f2f26a33ac16fd108dfa |
|
MD5 | be503a337b898fbc70a058acacd59d3f |
|
BLAKE2b-256 | cdcf65b41dcaa18d1c4b7ebdc00a616a7282fbba2fb7ea66d4fef37798197210 |
Hashes for testghacookiecutter-0.0.89-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcc4371e877f2fbb874704e4688c5272b9985e7c8bd348a643965e507517122c |
|
MD5 | 43d08959e9b2e3e636b6838e4135b3a4 |
|
BLAKE2b-256 | dc3e2c7676e58a74ae09531ee5eee484d32fe4362636aecdf63b268e83c4f4cf |
Hashes for testghacookiecutter-0.0.89-cp38-cp38-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f702547c49fad4f966454c960ecf6a165fd967543ed5f5544186c813388ff9b |
|
MD5 | efdd0b91a3aa2ab1d627f49a40b35537 |
|
BLAKE2b-256 | 28ff3a73fbcc6b4e5149935cbf9d7e732f593338b400d4ee42645600da812ae8 |
Hashes for testghacookiecutter-0.0.89-cp38-cp38-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0164df717552ef04e2f71adbe8611b86494047f49849950efe2f7b2af3853d52 |
|
MD5 | b8cbc2c14355015db877633a736a962d |
|
BLAKE2b-256 | eb920522a26445f54aabf50a87beaceddb98912e5b67c7f3ecb7dff40137c62f |
Hashes for testghacookiecutter-0.0.89-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7932e6f3b465aaec8aa43d1d786fa5da8f1b57e4b2c2cdfff43d387cc640319d |
|
MD5 | 50a4fbd9e6ee3a70ca244b3b2571bb1b |
|
BLAKE2b-256 | a3d31cc2dfed8a1204053906ead1b10e3ddc4ecc40eb191a00c4a1232f06dc3e |
Hashes for testghacookiecutter-0.0.89-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e3c323c569b41c139533cf08b670bcfdaddb9fa8a5af6c152e6706d0d94c73f |
|
MD5 | 59d09a25607e46ce613bd91b00e4c5ab |
|
BLAKE2b-256 | dbe39f6187c58d9cdd01d3c206eaf2d931708a4982f02c8a5dbcce10b84acd50 |
Hashes for testghacookiecutter-0.0.89-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a128cc8c292a0d8538a6d9f918a18990fe3ff1537d054057b6338eea732e7f8a |
|
MD5 | a998a0c823271ba3d7b6e0d3ead9bac2 |
|
BLAKE2b-256 | 726494e389755cad670407c453956d723f5667841248fb34a83b3b9b57589901 |