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.99-cp311-cp311-win_amd64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp311-cp311-win_amd64.whl
Algorithm
Hash digest
SHA256
e77a034fea9a4b92ab2ca8d3b0659a0917325c3aee7b58cd078c1d8a35392f9c
Copy
MD5
abf41af010c09138ea72085923e5d7d1
Copy
BLAKE2b-256
604bef030c06505ed65e15f5456495777a6fe318c4713f89fa7f82a2f0a7bd54
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp311-cp311-win32.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp311-cp311-win32.whl
Algorithm
Hash digest
SHA256
b959aad5d3aa68d11347b2793ad63b8a475d37a2a349e9ce27fd287adbf4d414
Copy
MD5
7775ba20669551bdebd25db078fcb790
Copy
BLAKE2b-256
31d93de6e90923580ae5dc56a417b28b17287ed511ac0387e20534933d05bbe7
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm
Hash digest
SHA256
0be6056502f9352ecf3cf12d6534c7342188677357eb42fe6d5e902cf73a851c
Copy
MD5
4400f18512d307b78d6dd543aa16ccfb
Copy
BLAKE2b-256
2ad4879817dbcd579948de89d34333a42f5724ae781a49f38f75ca9a3e67ec60
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm
Hash digest
SHA256
8a77fe1de85900d6849cc0e349768667b8d1bca017ef925ea4cdae817090073b
Copy
MD5
9159c4052db9f39df7c7467be087c6e8
Copy
BLAKE2b-256
f703f2daea11ac5bcab29eac00cf305fe0e4e968315b4c41d0fa55b951dbe8a7
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp311-cp311-macosx_10_9_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm
Hash digest
SHA256
34e955933519395faf03d1137fa72f45899d3551e41ec4e9999aaa4938f88c7c
Copy
MD5
7c7c78f82f0a2cd6ed6706222357f079
Copy
BLAKE2b-256
9563edd6dd3974fbd26a68c918ab4f7ff24c5ba4470e2c755e435ae34ae6f8d3
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp310-cp310-win_amd64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp310-cp310-win_amd64.whl
Algorithm
Hash digest
SHA256
c2357d381075128fe8f913775436ee482b7f51a7d5beac4fde5e3c6690d996c5
Copy
MD5
03f5f550e2b50deb8ab5d2a5c3ece8a8
Copy
BLAKE2b-256
1347d59becc70b6afa022d5cd0761a504877333dad678c11808e70922296510a
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp310-cp310-win32.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp310-cp310-win32.whl
Algorithm
Hash digest
SHA256
27e71c6a67d55f11359fe6e96f1f90b2b7c21d32b0ef12592006b5cfe1983574
Copy
MD5
d3027930a5507ed7eed8a7beb2ebd45b
Copy
BLAKE2b-256
22680bd3d0eccc98d1c7b3ab50423de71986af15c655af65fc3aa756a24663f9
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm
Hash digest
SHA256
e1090112382e24e651ad836c107590cf26f3323063d29da313ec4e727a2b2d95
Copy
MD5
94ea908efd255dd0997e46ee592d87d8
Copy
BLAKE2b-256
b6578a49dc561121ccb2a7928de852f6d18bdeb02f7ed87e70b64a33f2a11549
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm
Hash digest
SHA256
f070d4c762ec7322ab4ea6b4b795cdb3b21a24cbd8ca881fd876cc1e07bda90c
Copy
MD5
1be9b4cbc01d9d4a534c69f4081af000
Copy
BLAKE2b-256
dca96980c91879595a41bc61adab9052221a3a5f5666ce54e7f166d2f40e74e9
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp310-cp310-macosx_10_9_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm
Hash digest
SHA256
e16e57101b72d5b73eff7aa0cb2faa706dfb369c2c733f8e06827be8f0a00405
Copy
MD5
dbdea18d4a9583bc2aee03007553192b
Copy
BLAKE2b-256
5bb27bf3a1ca7fbf18ab3ea73365ddadf3a37bb67dd9fbe606e143b2f4cc5f1a
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp39-cp39-win_amd64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp39-cp39-win_amd64.whl
Algorithm
Hash digest
SHA256
d765ab51e0f4c078020f2b1f38b4f3e350ca077b8f8926d6014ebf6075ffa3d1
Copy
MD5
b9e1a6582f2209447e941455eb62b4a3
Copy
BLAKE2b-256
461ce371c1bc3433190650abc4a206b866cc8bba4061ae7c8454aa547baf8f1b
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp39-cp39-win32.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp39-cp39-win32.whl
Algorithm
Hash digest
SHA256
6aa1595399e8d0c30c3ecd5799f307163f5553299f8356d496df43928c19e2fd
Copy
MD5
30ef7a496cb82bff6b55e5714c10f3d9
Copy
BLAKE2b-256
918d3ee05873ea0d6f8478b8c2aab5c7f578e307410bd21c2aa22bb45edea44d
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm
Hash digest
SHA256
b46ad61440f726dfe30935534199f1fa4b50b4f46971ce9b8393d0098db847f5
Copy
MD5
2a220a52c7e684b1380c38c795294e46
Copy
BLAKE2b-256
df932bc16aec52ecabe9dbc24edaedc8925bd3638764cdc9cec32be6deaa767c
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm
Hash digest
SHA256
c2b08615f7d1ff124e07375bdc3cf4f3b7cad2d41462c213758b1a4ac923cba3
Copy
MD5
3ec425b647a995074f11de2c3f9bbf26
Copy
BLAKE2b-256
af027eff7ad64215aed826415421dd0ae3b56f735e76c02cd490d68106aad84a
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp39-cp39-macosx_10_9_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm
Hash digest
SHA256
7db917fc6667db674dca9330f0a1f041de64f78cafad009aac64b5626f2dde19
Copy
MD5
db6c0e445ec3c30dc5c264421fedad32
Copy
BLAKE2b-256
91578f4f0351e6a8b2c0b1aea09cc75c32aef4d1c5902b849221846a2b68c22e
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp38-cp38-win_amd64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp38-cp38-win_amd64.whl
Algorithm
Hash digest
SHA256
236f78592a6a62d989b8b1e65ee87c190eafa590e05cf35cf4e2fcc1b81f8d64
Copy
MD5
395cc19db63bf6596e147d96d4c0fd84
Copy
BLAKE2b-256
f248587025617ba118bf507139da57f9d6b1960c27e6b8e3f98db8c692bc6df4
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp38-cp38-win32.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp38-cp38-win32.whl
Algorithm
Hash digest
SHA256
8ce3583a10264960181004a283436d902201996295be137c40df7d1c7dcef35a
Copy
MD5
9214f570dba03ba370c2989e182f5df2
Copy
BLAKE2b-256
3d83098593432a8645e845c5a43b5f5bac900470e291d6590a98d5b27237c749
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm
Hash digest
SHA256
552432f288217fbd91802379a05b009c8c204f4258b1646212fdc96cbe40efa9
Copy
MD5
3b330ac9055e455fe9600e27aa785893
Copy
BLAKE2b-256
0b9a2fbc14ba262f9137ad39c26ff45f7be06280dfd34dae961201442473e048
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm
Hash digest
SHA256
ad16cd83bf3ad67df87aadbc8014820300924ff2f9c9be26947e8072d7c865ae
Copy
MD5
a40f577515f671c9514fb0d574103dfb
Copy
BLAKE2b-256
0e69d945b5add04c00e11380fb96acfde010e6e6da99bb3427236d34488f6ac6
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.99-cp38-cp38-macosx_10_9_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.99-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm
Hash digest
SHA256
d5ce70980725c3a5c61d0524d7da6b4adb2bfc70db09ee86ce0e2a377e317063
Copy
MD5
957d4bfe9c3d88ce6e12e2ce2ef998a5
Copy
BLAKE2b-256
227ee47eb35001e0025d1efbaa93ba99af7030df9e992140d083d0fe0f7d3662
Copy
See more details on using hashes here.
Provenance