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.92-cp311-cp311-win_amd64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp311-cp311-win_amd64.whl
Algorithm
Hash digest
SHA256
a76524c31182925b20e008cde5dc9655bd452a6987ff161c96ddbed8002b4c85
Copy
MD5
2f1c02434c1d9c2b09f57c9862d19ad5
Copy
BLAKE2b-256
4d3bdf6b3247465baf63813cdc67ecf28019ca2e9e64ffbb09fe878bad484d55
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp311-cp311-win32.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp311-cp311-win32.whl
Algorithm
Hash digest
SHA256
d3f90c1436af5330d5222b84b287a7ef78d641bc3a73c20c8bbd51b6acebff5a
Copy
MD5
6070d5709d2782fa77a9e80778b04f61
Copy
BLAKE2b-256
8095901be1f2f0b3ba26a49774820b60e5e374f1e13a9d641610b272698a9a44
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm
Hash digest
SHA256
046e77e9491bb40e62d48f1c525129a509f24328d8e3ff0b1dd42e9fb1b82d1c
Copy
MD5
2c2623e98ed6aa505dfa8112fb69e5e5
Copy
BLAKE2b-256
22fc6e7d341d60b4ac4af8ab8d818280418dd0e3eb25beb7636beb81dd527073
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm
Hash digest
SHA256
9689e1a5deb1d9dab403d539f0bc1ec312ff5d7490107adee9db1f4ac4b9b402
Copy
MD5
fcfb91dc458cc9af03c104c066d3d01a
Copy
BLAKE2b-256
f69c38ba7db99f448ae36efa414a54f2c3b7fad633f3f8bbff560c75399b42c4
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp311-cp311-macosx_10_9_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm
Hash digest
SHA256
e82189f2098474fc8c7e2e709b6716c1b0210c250741ce929f1c68df0b0c82ea
Copy
MD5
705a05c8c1152c525fe96b7d5c6a0131
Copy
BLAKE2b-256
ce4abd4b7c738453338426bc1be1e9913cba9049455927b77f31528ea886e35c
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp310-cp310-win_amd64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp310-cp310-win_amd64.whl
Algorithm
Hash digest
SHA256
6979a6d2a0c62f2b72b0f2cacd6b977a5ebb890422940a4d974cdb7d118ae163
Copy
MD5
78dded824aa69551f3f8790553e569a7
Copy
BLAKE2b-256
b1567ffeabe7fbe272233fdc5b5064208060ea65dc0ce2e522ef162266dae25d
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp310-cp310-win32.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp310-cp310-win32.whl
Algorithm
Hash digest
SHA256
f54176a3c3d008407046cbadbbceec2de5b94223b87bba10422027d3d10f7c23
Copy
MD5
1888342fd20fe1411a715b7ecaf9d29b
Copy
BLAKE2b-256
a192f34c5b81b7cd3b8fe179728475ec946e666e04d6dbdd5e5dd882b8c93a87
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm
Hash digest
SHA256
8dfcfb172220ed3a16106be5fd9363e9d4c884119475699036fb82b27b1d4f86
Copy
MD5
bb243047a95bd22d1eb56e493df861e8
Copy
BLAKE2b-256
8136ec0ab17ece72758ab9a2f3dfa11b485ed425db8a67d223975c3b5b666ab0
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm
Hash digest
SHA256
cbac355e1ba2cf801c6e797be9819322d993e9dcae4ec3bd9d66a870f55d05a6
Copy
MD5
259a7d14e27bc2d64e3506fecdb93805
Copy
BLAKE2b-256
3c97158fdb4a456e3d129bde94a69d89917431ea0b86d47ac9cdcb181135c301
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp310-cp310-macosx_10_9_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm
Hash digest
SHA256
a4cb35cb34e9c4274959df53674226f15ee88057b53c467755024736f6773158
Copy
MD5
0ae94c649c596b8e011d962520a3e59f
Copy
BLAKE2b-256
7e3ce5f1204b5ce35073211db11e095844ab669f83ce28940069561dbb98c125
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp39-cp39-win_amd64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp39-cp39-win_amd64.whl
Algorithm
Hash digest
SHA256
f23c83c0bddadbd0de7236076e15433236ced618b6a9742c836a4355db97a80d
Copy
MD5
d0956437f0effcdfbc08d0372d23236e
Copy
BLAKE2b-256
4abb80f9f3d6827e6fdd00e8801670400896ab92503f16ab887fa2fb6ee82b4a
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp39-cp39-win32.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp39-cp39-win32.whl
Algorithm
Hash digest
SHA256
fd8430c797bbaccf1e01d3ab1b228e097c5e2b05f8119c93a5669bc36d38bd45
Copy
MD5
cd490506209595e744a46d8cb744437c
Copy
BLAKE2b-256
dc6df1c1ae618acaa3dc341a0d3d6029d2983451283c88f8aaf87deab336081e
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm
Hash digest
SHA256
80e2c6fc14c4f5d29f0fc1b4300359cf57c2d74a95d269fa1d8cc18a6c807f6e
Copy
MD5
d071cf8b79f6e73e6bbf467c426d94bf
Copy
BLAKE2b-256
27b3ca0451cf6afdd7d54f78cdeec2d558252e8ca1ed1e13e828b2983fce5413
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm
Hash digest
SHA256
5b296554667c54173080e8844742ff0700ddfc3689874875195e758ba7e912ad
Copy
MD5
052633d122e833933afa3c73b9343489
Copy
BLAKE2b-256
d2d1d49928ba669ca06c2a100b2ea4115845ca7e0b5cb0ca683f7ff5b4149785
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp39-cp39-macosx_10_9_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm
Hash digest
SHA256
e6091e4047620d354377aa1cd871491fa288bda499d8d71a7331d8f459ba70db
Copy
MD5
98d1307a4a5936446d3a4513680e58f1
Copy
BLAKE2b-256
db38a4419e62d98efeb6a09849ffffd31db9138ba35565b705824cebb181c5ef
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp38-cp38-win_amd64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp38-cp38-win_amd64.whl
Algorithm
Hash digest
SHA256
afb5d50fb3d1ba79176a69a2bb946d6686ff9199d10e4d2fce123cdeac13ff75
Copy
MD5
b88ec7ca6581e1138cba7d419f90a666
Copy
BLAKE2b-256
fda3f99120cee5e177e9055b53e909539ebbf6cfa91ccfcd0659bd7035c7fffd
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp38-cp38-win32.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp38-cp38-win32.whl
Algorithm
Hash digest
SHA256
fff059a59f4c086c895326e81514a7631f96c9f7e316ff70ac069729db3dd0c6
Copy
MD5
4e62dd326877054473aca38095000d2c
Copy
BLAKE2b-256
714e9eef69e903b6e646a4b07f9f6e21122fc102bc3d976fe29624c5a0e5037c
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm
Hash digest
SHA256
615eb920681158e8bcaa6cf78f966fb36249087cb1724e78114eae3cc71e5141
Copy
MD5
05cfa9393493e287e6f02de378de2404
Copy
BLAKE2b-256
c27a4a13359c22f793c9482cadbebc7e44ccebafb2005828a81151d84fb88bed
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm
Hash digest
SHA256
25617dded1fa6edc0225bae46eafeaebe7a2887c34836310847eb8746a60576b
Copy
MD5
1a47f25995fc55228ba30bb4f85737f1
Copy
BLAKE2b-256
07c6eb4507621020ce6e489ba479e1f101a4e4413136b6588a3ec2dc2aea9a61
Copy
See more details on using hashes here.
Provenance
File details
Details for the file testghacookiecutter-0.0.92-cp38-cp38-macosx_10_9_x86_64.whl
.
File metadata
File hashes
Hashes for testghacookiecutter-0.0.92-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm
Hash digest
SHA256
c16a71a2077bf4178657985ea6640443400ebcce06c864467d9fca5dc9bddf85
Copy
MD5
dbca1ec78973193c8d63894cda485633
Copy
BLAKE2b-256
859f2fe1f86d4afea64bfd695a8b9be09371b77f95ba8515b2d4779cd5bd92a4
Copy
See more details on using hashes here.
Provenance