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.90-cp310-cp310-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4621441325392ded50b1b5b4fe0b7ef0c80832dafdd6a280cf017ac664ce272c |
|
MD5 | 0733e7e67735add688000712b7d93deb |
|
BLAKE2b-256 | 91dce0e8811ba7971b27bef0ae022a622bc2537cf529cd09412de37252304686 |
Hashes for testghacookiecutter-0.0.90-cp310-cp310-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9fb80e7ce2b95d45bf4673c59b7931fc3a208b6a2b7e94ba378b6e15b973ebfe |
|
MD5 | 8f947463fb33e4824269ac1c9b093d64 |
|
BLAKE2b-256 | 1293fcaefa31279eb2dad54ada6b54ed35541452dd36a9d626dbf9da6146a4e4 |
Hashes for testghacookiecutter-0.0.90-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 31583f9b8a98c0bc04f85dc05031922f56252b4078a4122e2d16202760c83230 |
|
MD5 | abf7ec54d967dccb6981450356fe911a |
|
BLAKE2b-256 | 36418bd84b4aecb20396a7b15d0b745cec64a2c12415c8351e7994b537f2f619 |
Hashes for testghacookiecutter-0.0.90-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b45f42ec359f078f8f9bee0e76cb39626080a498bf047482bb6ebeda290c8192 |
|
MD5 | adc8e943ad4451c477361c1dcee8eee3 |
|
BLAKE2b-256 | 9daef0c64806ebfc16750504ec2f4b3489f75d6f6906a944402b710e4a0f9504 |
Hashes for testghacookiecutter-0.0.90-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ec39d607075a7fb8a3b1b9bf0e30b2272508fe91f7420cac5c56302539b2a35 |
|
MD5 | 6653683503d6c0de81f3cb8b4f63d9fb |
|
BLAKE2b-256 | 16cdb8e778f75ee75bb8d7f6db25a3d15e77af76b6792dc943b72ca55a81af07 |
Hashes for testghacookiecutter-0.0.90-cp39-cp39-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0ad5eb369deb8827ee9a1647f896985cbbc7c1504ba096833ea856e51a2f11d |
|
MD5 | c1f8fc4d120b35ca6f5fc7302f69cead |
|
BLAKE2b-256 | ece9e646e0898c6584149927cf3147a339777038f6e6f5cb972ae64f44f95a3e |
Hashes for testghacookiecutter-0.0.90-cp39-cp39-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10de94966e33b17b643df6de33b1a5230efe6a6859ceb8633344db6e926c6be0 |
|
MD5 | 96d3b834b3f1855bd5079ab8b76a4b30 |
|
BLAKE2b-256 | ceebf52a4270feb27d37e3de728f1453439fcaf35362ac976677dd07794335a5 |
Hashes for testghacookiecutter-0.0.90-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e2dcf448b2f6f44c62cd7dcd23fe69b3a830aec74f7c271b6cc6c25be13763d0 |
|
MD5 | 47152765c155d231248b9063575f12b7 |
|
BLAKE2b-256 | 41825ef5ac1a6a416c26c7b37b8e7725cb380f6b870eabce82a9ba372976b458 |
Hashes for testghacookiecutter-0.0.90-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7502016464fd7b60935f4b48cada493f0a9c77d55da2836f2df1f56719af28d5 |
|
MD5 | b6ab8948c9bdaca8580f0037fcea3f55 |
|
BLAKE2b-256 | 7b5e1526dfbef2aaefc3861b66b7d84399fd9e20920c824bc2fa0ca9d53f8790 |
Hashes for testghacookiecutter-0.0.90-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8516a2c439347e6c372cf1ec86881ac407419450c10139f6483411a39ba63fa3 |
|
MD5 | 45dcd3633db0c744646ce46f89431d79 |
|
BLAKE2b-256 | 3ea3eb0a0c8aa32790edb62b54f2d1f8118059186de815929fc9f5e741e4086d |
Hashes for testghacookiecutter-0.0.90-cp38-cp38-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e8c8f413f935b73d30600292dbfbb09a26811e59e55ce02d70575cbcabdee6a5 |
|
MD5 | 66f66e963d60e502916de75e10609d53 |
|
BLAKE2b-256 | a1caa0b5d867f9cf61e6ed4e1dedbb7872ca4656cfd9c99071628334f3917c12 |
Hashes for testghacookiecutter-0.0.90-cp38-cp38-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aec882e50240941234618bf7685e7fe304dc4b582f4c9e5782aab21cd5f135f2 |
|
MD5 | f26d41d0436b2b9808fed90ff15916c9 |
|
BLAKE2b-256 | 64c2f44e46eea374e6a38fd7316e08092c037f0dfbd5635124128a4b56b0901f |
Hashes for testghacookiecutter-0.0.90-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb2cb7edf9e45adb6757f22492fecb5ce39ac575a86e4308fe753ab507b0af95 |
|
MD5 | 408fd14e4b3db9d837bec34ee090d4cd |
|
BLAKE2b-256 | 02620840c430979f8d3f62fa57dd8fe30b70f70887b5b65e4a87e5bfc7cc72f8 |
Hashes for testghacookiecutter-0.0.90-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e11b02fb9e018de57a60d5aebef2cc133b8b748af51d4a480612534799fe334 |
|
MD5 | 925517336825259aa554e61179d5ec63 |
|
BLAKE2b-256 | 8733388f6bfdef8f7fed6b00074d7383cb7ca34414973da69d6f474df902858c |
Hashes for testghacookiecutter-0.0.90-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 067b9d3d0914b95c5b2b5741b7d67b58b0f0e085e68276462d88ff26b3d75829 |
|
MD5 | e697bd3b9c621471f19ab6c3694cfec3 |
|
BLAKE2b-256 | ca07066d41920e2c8a906b0c1ed9af7b25fdf28e82689f0d411b77afaa15e039 |