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.
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
File details
Details for the file testghacookiecutter-0.0.91-cp311-cp311-win_amd64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp311-cp311-win_amd64.whl
Algorithm
Hash digest
SHA256
b569a847b09c15d8e2086827086d69b2ce6e49b3da38ad170f50e2b9430ddaa1
Copy
MD5
406150c440df6a177aaf1e43127e420b
Copy
BLAKE2b-256
842cd734e663c3fb0abb3b9c39eca6b80741eb2555004636f0d69ace13788341
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp311-cp311-win32.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp311-cp311-win32.whl
Algorithm
Hash digest
SHA256
cc4e5b7f42bb18e3a8e0155b0a98b036a8b0ee973cfe43b21c4b8e56986e2c0c
Copy
MD5
aeee4be404027eca687b38d9821e45e5
Copy
BLAKE2b-256
1fdf7bb1dbb235b85b7b6072f3b45811a646731e9d2d76acfae42f1149c12af2
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm
Hash digest
SHA256
6a8bccdeebd6d3313bc11f0e4d98eef3aaa899621cacee1cbdce5adc5295c1a5
Copy
MD5
6b433b540d38b5c8ffc6b56d17acd880
Copy
BLAKE2b-256
8ad9cb41159d9513184c4b5852f35cd8fe6d0cf48d66288dd6d71b97145aac13
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm
Hash digest
SHA256
d36507faf72059213abf95699351d982635158946da5eac1964159359e5a5861
Copy
MD5
be0068e17d54761c70b78944944b1d88
Copy
BLAKE2b-256
bf5981833e01c7f5efd195f6e7c0f6e0fa8f62c448a90df7ed49d41c94b113e9
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp311-cp311-macosx_10_9_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm
Hash digest
SHA256
bbc7b6a7a848338ac6abec72ba9ed28ffbfdaf14e110732740f4bbc3f3363352
Copy
MD5
b443225ec1bb593377ade4a0899f0a68
Copy
BLAKE2b-256
3ca1fc1e379f87a030cd9e9f3d501e5359ce5f821191b49d4297d01576d67fe6
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp310-cp310-win_amd64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp310-cp310-win_amd64.whl
Algorithm
Hash digest
SHA256
2870dcd23c5e4007e343cc4b923e2a644ce8dfd315318226fb3fbdcaefe80ea2
Copy
MD5
281c3710fd6301049e2853d99d5ddf5e
Copy
BLAKE2b-256
725d3e7febf4d9d0415d1457e70c06c0e91c127e732ee4e068ae7d1bfb28cebc
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp310-cp310-win32.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp310-cp310-win32.whl
Algorithm
Hash digest
SHA256
b34b9f7583f2b1421937b08d36e6b163d65c5bb35adee87e1ac78b140a5ec6c0
Copy
MD5
279f812592a583c2b06f2168b3d5be6c
Copy
BLAKE2b-256
dfbda723c9dd1b168ab2a47833f020a2d2b9a99e066eca66789a770b32762a98
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm
Hash digest
SHA256
874c6e3232824324a529c6a334a1a0224ed0e14011294898eef680af085144c8
Copy
MD5
a75decd1f6558fe01b43d2ac99b51587
Copy
BLAKE2b-256
04f0a678f75c2b35a87875e30f69028b48eba13d7c5451cfcfdf24ecbb0188d9
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm
Hash digest
SHA256
2a8fad5feb3bf6a920c08239324df3de23477ed7e2dd574aab31fb403ec475d0
Copy
MD5
89d062ba024479e603fb33d09e2ee490
Copy
BLAKE2b-256
4f6426d8365ae6dddc25a51cfab4649344c70fc280cffb357cd69ec614155a6c
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp310-cp310-macosx_10_9_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm
Hash digest
SHA256
b58dc4a5ff239bd6f7b57081208b36ead9cdae343c47f711c7ae0e695e4cadce
Copy
MD5
dfdd8446029dd2e35d3ea3650b51379a
Copy
BLAKE2b-256
dd887f667a1e877cc5e80e70711ab6f6299ece30ec950f1113aa38a78c4a6d75
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp39-cp39-win_amd64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp39-cp39-win_amd64.whl
Algorithm
Hash digest
SHA256
0c17d129954d83af650b55c251ffb03b64214864f4602d1784308956243fefae
Copy
MD5
e51657273064486713628356c9889af1
Copy
BLAKE2b-256
f9a4c93e4e8ed4db85296385f23b2a1206c0d3c6a5700d6bd99ae39c32cbdf1c
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp39-cp39-win32.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp39-cp39-win32.whl
Algorithm
Hash digest
SHA256
6efb0bdfa45463ad9a00b1fbfaecd37a9a212a778c8430e2204861ece8fcb09f
Copy
MD5
5ebeec085d2ba927084381eedae17f1b
Copy
BLAKE2b-256
297ecdb68714676bd4fbe53f923ee564bf561877293c3171d4ea412559c10c7c
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm
Hash digest
SHA256
54f3067e848038429954e70287698860bc032b07d11fcc770747071bd78ecfd7
Copy
MD5
c0c5ffceeef600a2eb655961a9308440
Copy
BLAKE2b-256
a6b11c8aa9b76b235d3fe668795611494e2c933e684e26088386461d30187312
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm
Hash digest
SHA256
830e2369d38dd150673584805ea5230560a3540859aa80f799e3d6da859a987f
Copy
MD5
d73729d95cc21b5279275e33755dd6be
Copy
BLAKE2b-256
fc3ce8b15033b5bebd1f2f397526491185286221e4f59bc8ce5c8b9b96eb637f
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp39-cp39-macosx_10_9_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm
Hash digest
SHA256
e005306db62e8a2653f5e3a4e0f5c84cd82aa2a7d21bd0190ae99bb6e035796e
Copy
MD5
2d47b24d04b75a7d53b415b6511d5916
Copy
BLAKE2b-256
38cd0faf60334b762ee3908b7fe0ba0c72d553601971bce45556d17301e2beb5
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp38-cp38-win_amd64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp38-cp38-win_amd64.whl
Algorithm
Hash digest
SHA256
14a9d5807020596d521ab3ddef7a92b54d5a6951214c1bb09fc3c2394394c691
Copy
MD5
173a137302ec2a5f35204346d145d9ad
Copy
BLAKE2b-256
d207a9970015ed5ae178b707cef98ba8eb743e84b9ac97277f1410af4bb3233a
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp38-cp38-win32.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp38-cp38-win32.whl
Algorithm
Hash digest
SHA256
02f1afd8ee0d59eba51fc4886955886a4b65089b80c78b6236b0867214d8edf3
Copy
MD5
6a6facd6b5ecbf59b7fe1739821ce6eb
Copy
BLAKE2b-256
68bafbf748d6070859f877bd3982d348a8f36294339ab1a14b2d7997ba84bd34
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm
Hash digest
SHA256
3779a8ed85228ca1856203f1e2ebccef49c8ad0ba7fb6bca590696c5b307c7e2
Copy
MD5
a7a126316af0a13740114fdc7b14d898
Copy
BLAKE2b-256
4aeb608e031e9b32b62b98fac200caff4c2e145cc84dfd9ae6ccb7565981ac7d
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm
Hash digest
SHA256
3659ee3915be5e1c8599a531d1b3b3b1762851ec5b40c886b3e138814ca49517
Copy
MD5
42114ff17c5b72914d44c14a078fd359
Copy
BLAKE2b-256
022cbd67372b8f8db7abdce0d37895a50424124540b1e63cb2d6c22540a33d3e
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.91-cp38-cp38-macosx_10_9_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.91-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm
Hash digest
SHA256
f41995bfff1fab18517afb3f8ae8c52be84ca16c5b7d093a4b2aecbe351c2255
Copy
MD5
7e3c88abb9fe81b1f0c1f04efb335b0a
Copy
BLAKE2b-256
88b52e85c80190a8352c4e9ecca1b07ba9ca749e7889caee5ec5f103b96638c7
Copy
See more details on using hashes here.
Provenance