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.82-cp310-cp310-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 025d1ba6da7897dec395bae6d48383da845a35db87bb460f7c82bdf4c3c732c7 |
|
MD5 | 5833c412f5d0c9e06d755d39da0c3ec8 |
|
BLAKE2b-256 | 7ac6651a94c0aa9e3f16714810f35cf392b410600b91a0799aec9ad9e066a943 |
Hashes for testghacookiecutter-0.0.82-cp310-cp310-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 800255f46a6c11770f19bc9b9a0f165898ae2ae47d0404e148d12ac8006e21d5 |
|
MD5 | d709c924fa88bb807b7b0300675a406b |
|
BLAKE2b-256 | 9c93ab433ccd96ac3a2759323de5ef166e85c38c5b494f2c8501166b8ab96e2a |
Hashes for testghacookiecutter-0.0.82-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba4f1c69797f074a0cd436844a6bf77579826f785321ae5dbb2ee7a117d4a9c1 |
|
MD5 | da91a027e6dc508afb92045fb95fb322 |
|
BLAKE2b-256 | 7c0d2bead0343a2932221cc2850c9739a19e3744adae978a9c0e4819ae27e9c8 |
Hashes for testghacookiecutter-0.0.82-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0be23d2e5dc3ed73b059963032bffb098d90b5ffa776303d2fac3c916b21baa5 |
|
MD5 | 5b77fb0152c56315d5857a8868db191a |
|
BLAKE2b-256 | 316c8a975b2cb0ef92672c7ddc5244ff797b7453fd7e8ffa545321ba5d8f44cd |
Hashes for testghacookiecutter-0.0.82-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27972ab9cb01b860934ea5eac1c20cf72a6db81b084482140e458450334dfccb |
|
MD5 | 791e3940246d6c8ce5185fdff8658e71 |
|
BLAKE2b-256 | 01290a1909556c52b83bec7066cb9f262aec13f64fbc955ed0c8d6ab1d57d199 |
Hashes for testghacookiecutter-0.0.82-cp39-cp39-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5dc6c73d26d18781829eaca860cf7eaf34d79fbba9b664a26aab10d91dac688e |
|
MD5 | 63d521e3a1daf2b78744a0f3419ef398 |
|
BLAKE2b-256 | 23f270a4660b81d4499c480792ac717f644282565c35aff08c356286052d3ef8 |
Hashes for testghacookiecutter-0.0.82-cp39-cp39-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a886419b5509f474de6fce14744b1f65371881abf83523650086b570050e9eae |
|
MD5 | 9158066da3210a79acceed943c63ad86 |
|
BLAKE2b-256 | 652a15d736598da3236b954a8a0cbc935089eedf3a932868c3e8f0c4d5b6e80b |
Hashes for testghacookiecutter-0.0.82-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5276b3d747abb4e1fba0e234617d21eab9ae2ab6e50e852be169f132dde11b84 |
|
MD5 | c2fe59136d9651caf4e7481a777ea733 |
|
BLAKE2b-256 | ad85a20add7cb53ea75942b4a5791600884de58cdc0cf812d2ef2f605427335b |
Hashes for testghacookiecutter-0.0.82-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | daf9186c5d2d258d0aaee17e5b004335c5373215df646ac53dc6781ecec4ca58 |
|
MD5 | 194c1571b213691863cc8e78bd994ae5 |
|
BLAKE2b-256 | 85df1f64f74f91d799fe1d9aa376813e73aae47e68eaba78dbecc6bd20ebe370 |
Hashes for testghacookiecutter-0.0.82-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 518f765c0511d613bdcab46f447d7943f2cd2ef4fff7f2ab46507f690facd2af |
|
MD5 | 11f82e4cffe8b8df24a5799a574b4c0b |
|
BLAKE2b-256 | fe7b67c82853065e055e245dfa51a9f5e832e316fccef2dde52b66bcf2cdcbc4 |
Hashes for testghacookiecutter-0.0.82-cp38-cp38-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f41d1c7c2b1fd8575b3a5fcc4f0fde9e8edfcb654c023c0ac8a71872eaf37f2 |
|
MD5 | 3b829b77992bc63311cae5ff43c6ba13 |
|
BLAKE2b-256 | 62c85964dd849289be7a3e13e8e8e161de6b92ec86049fe6fc2465c1faf2bac6 |
Hashes for testghacookiecutter-0.0.82-cp38-cp38-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34ca916a9335b74f031ecad3cd38064259ca307ed5274ebf13961bad3dfe9fbd |
|
MD5 | 30e823298a300e5784f2bd39798b5cba |
|
BLAKE2b-256 | 18b6c225f4be0fdf40a534e3d6559b969d622ccdba725c687dc344d382c57e55 |
Hashes for testghacookiecutter-0.0.82-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28cd8104e8ef58061a3bc20c21f1d12e1a7e43783ba3cec5930a895a7fb8120c |
|
MD5 | 5dd183de43096e5375c23eb2e7b0fa67 |
|
BLAKE2b-256 | 882f40a4ea6cd14553ea832ebfe4423ca108a295e2cfc7f2012983f0e63e0df4 |
Hashes for testghacookiecutter-0.0.82-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a6620d49ec467bced8db9b4e9c577b512c9cee00d2ab5c3d2bd2e29358e97ca |
|
MD5 | a50323e73f674bce59921143a23955c2 |
|
BLAKE2b-256 | df040757b6b2a08f6015b4851b8229ff4a9b82df941183b9d6c5997ecc4b7644 |
Hashes for testghacookiecutter-0.0.82-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7df80d4ae88098417c0cfc0003fb4adca6dbc771e4ae9aa3ae5dccb05a7ab87 |
|
MD5 | 123dfa8009bd4e338315fc54f30ed421 |
|
BLAKE2b-256 | 14ec992e50599a5b85f0d98e19f3a27621506f7995e9e7f2a9ae3ec598a10b4d |