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.85-cp310-cp310-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e5bc4b2d2fc789e1598bfbe094acf722da3b349bd7f3d23fb4bac5d656c30e43 |
|
MD5 | eb4890dd62c1f9c496d27911a42c81e9 |
|
BLAKE2b-256 | 7586f1c8f165ff0330040fa2d0eefb2558e52267e573a2ac18a26e39bd045444 |
Hashes for testghacookiecutter-0.0.85-cp310-cp310-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4700208053823b31fdf455f62edb4d5c7211f5f5dbada2538f2d48180bddf65b |
|
MD5 | ccfe908761bc2eec62b534954ebc85d9 |
|
BLAKE2b-256 | 101251a163e0793aefa39c39c7c275ee1e24408ab88ac09157ef4291517687f0 |
Hashes for testghacookiecutter-0.0.85-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7c6c9ee8cbb2a7c5f5ce91659330caa4ee83690061fd232980e2a119b81e4d6 |
|
MD5 | ff7476936a401e142f3612a95e5627cb |
|
BLAKE2b-256 | dd2d5554a17748a8f645cafcfa991e7994fc26515bb1e87767c001aed37370f7 |
Hashes for testghacookiecutter-0.0.85-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 179cd1580c6f7735bb5899935a7374962fe3da51243c5fe68b66435c08138989 |
|
MD5 | 29c3a9b109c56aa0326ad71f5d9a28f1 |
|
BLAKE2b-256 | 572bd0cfe95446c5089e0c250bc110c2af9f6567fb13120727c1b7a200240865 |
Hashes for testghacookiecutter-0.0.85-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c06751cacfaa6541eee41a8afcb36bf25bf348d3f864aa9ff7c34f14447f247 |
|
MD5 | 0c4d1ab4c67b6af70658ad3ccb367e57 |
|
BLAKE2b-256 | dc3696b0ffec56fafd2036f151ba7d3278de55447d0f848a525912cdf68d0285 |
Hashes for testghacookiecutter-0.0.85-cp39-cp39-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 154f4ee622bdf704686d1693dc0fb766e43859895cfc0e9d361e361232aed77d |
|
MD5 | ed022db2c7b06bd80515c3a8f3a25dc4 |
|
BLAKE2b-256 | 6c560d7e395480d61b2fa9ada798ce3c4eff9694b55f299d57945d719b42011b |
Hashes for testghacookiecutter-0.0.85-cp39-cp39-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1e5d6f3fea11be0d67c84d102f8058e0dd827d91196d4121a75167351fbf896 |
|
MD5 | 9dcd659c36e884316ae6f24c15373ef6 |
|
BLAKE2b-256 | 8e86a260db89b0b68b080aa9906acbbbe205541fde057c5610e2774bc02879de |
Hashes for testghacookiecutter-0.0.85-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6dd99c3c6eb376647674d804ee77c68128817e8b39fb7adbaba739db0eb239cf |
|
MD5 | ba4e3b3cf3f8b6cab472078e37f0fe53 |
|
BLAKE2b-256 | 797515e3da9b6a64027bcd4e9a11c932a286a98bb811cfd154f53b776fccbc28 |
Hashes for testghacookiecutter-0.0.85-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b41a0c252d9c7f6e9391f5ee68006a3b1f28f77aa7cad266b844c8c59cb8326 |
|
MD5 | c83bf6f047a20860001ae773015f6b4d |
|
BLAKE2b-256 | 4ea488e5c810de3b07e8691594cd5a208a0a41814ae67387af87c189f5a78a27 |
Hashes for testghacookiecutter-0.0.85-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19606658cbeb6a27df94e69a6ac9169ab6aa49b89b550cd0864b6c523f606ee5 |
|
MD5 | 81ae6ae535b2ac249be1d3e52c73ed96 |
|
BLAKE2b-256 | 4b9fe19442d0dc1194aee102d09c9a269a700c6fb0eaf389881359e8fcd69e48 |
Hashes for testghacookiecutter-0.0.85-cp38-cp38-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4936e5e4e3f638fef85b32406a191f9c4ff9ed690b6568fb6e4d4b8e6864dc4b |
|
MD5 | df282d03195ef48bccb65f40339aac1d |
|
BLAKE2b-256 | 75f544440c82f585e525767d2eea1081d4dc2f54a24ccd023a406b839c9cc547 |
Hashes for testghacookiecutter-0.0.85-cp38-cp38-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d057eb402844fe92f71b05978da3dcf07502c943b83966bca21a441227913cc6 |
|
MD5 | 03bb14b774db503fdcf484f7499f2bc6 |
|
BLAKE2b-256 | 7fc5267a1bfd7c15d44d1f8cc32b63ef9c91a917e1e12cba46c23cabdcef6472 |
Hashes for testghacookiecutter-0.0.85-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc6d2c6df88b2ac2e1fc69ef93437dd0bab3849e9132b5b32078e26b8d4c283f |
|
MD5 | c9f1c13a89d075c61a7bc8babf69319a |
|
BLAKE2b-256 | a469ff5f0b8061f6aa0b209aff87f0388061f46583fd64922b804cc66afbc2bd |
Hashes for testghacookiecutter-0.0.85-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1fefa877e3e35c65724174bf5df5b24807c2e5e87f590d0444207dd5815cdcb |
|
MD5 | fe91df7a52c732ebca5e8e136f3c064c |
|
BLAKE2b-256 | d7b0ead239a27d61c79eb5869e45cdd457d37c1e8f55515f88cdcfedc232d729 |
Hashes for testghacookiecutter-0.0.85-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 05beae53549e8c353ab1f25e4295618a2680d2a6da00ccbbe99438f6f5503831 |
|
MD5 | 20599d8590117682175cc31e3b781d15 |
|
BLAKE2b-256 | f71a3494730447b1fff8abf0278681592116cf74496002d13d3ab608b1dc6859 |