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.94-cp311-cp311-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c70ca53d83279a15ae96c4509cee0c4f8120583c71cbfbeb75d7c6042365048c |
|
MD5 | f93b623a6a8b0644edfb1454f88d0d49 |
|
BLAKE2b-256 | 34bcb5cf3807d199d95e8add2c62a0f03efcb3846e5eb8687ca931a9dd7f76e1 |
Hashes for testghacookiecutter-0.0.94-cp311-cp311-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5949fd1ff91101bc0fde6dbf350bcaabf940e8b6087e725731cf81c0e4411a47 |
|
MD5 | 952180a09771e20e47d316d00e8382f5 |
|
BLAKE2b-256 | 5cc6d6428d8b41796c9854e7c6b26b6928a0270a503dc6a4827a24cfebb8e4ef |
Hashes for testghacookiecutter-0.0.94-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8033d8f6221587c239cd24fc9e19e674c8db3cb6df289f3b5b70300751429c5f |
|
MD5 | 5a0f2afe1e4ac80b5b828e74b08a4cc4 |
|
BLAKE2b-256 | 81b9e997a755983fc77781c2afb85df3e8cc08d98ad51295452407ee0ca594f9 |
Hashes for testghacookiecutter-0.0.94-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44b1ced1917343af344bf1cc0e9e88de51c270cfeb783c01d881634897c41aee |
|
MD5 | 4a0d962bfde6138de48c4719c9e3a0c5 |
|
BLAKE2b-256 | 8ff3c21725e90718278a135adfd3097b127d36b390bf7f788ed8ec90d2462bae |
Hashes for testghacookiecutter-0.0.94-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c8c9461229c60abddbed33640d51481cbe43af24ef26d8e4eaba1c8526ac3569 |
|
MD5 | e42a7e1dafdee0d3f41b6170d855abb1 |
|
BLAKE2b-256 | e5bf7242f77ee201b00b93fa904394d9bc3299a10f26d8b3068e4b0c4771acdc |
Hashes for testghacookiecutter-0.0.94-cp310-cp310-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce81a033d8a0f35d11a10ff3bc28d332faa3e80ac765290015d35b7798d5f479 |
|
MD5 | 3e1b279217188cef9a40b4fa359ebb89 |
|
BLAKE2b-256 | 141ffb04c7ecf3d62b675b04e0facfb53fb53c181a1c637dd3765d7a9e3c8c22 |
Hashes for testghacookiecutter-0.0.94-cp310-cp310-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 384af2cc7d3b38645917126f5046a1684f1a793a0ee207d2630e3fd54271d524 |
|
MD5 | 31f92ed18dd6199e5cb9f9e861da290a |
|
BLAKE2b-256 | f873fa525bbfbbd2248c0d21e468ebdd69362f19acf170a1cc5122b414c9278c |
Hashes for testghacookiecutter-0.0.94-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 264521042ff56a50241d3cf0ad82a318c4b2ed33c980cbd284b572b435c6a9ca |
|
MD5 | 18975b5db224f39a37f82ac202fd3024 |
|
BLAKE2b-256 | c5ad7a4e930f885f1e50f47c592cec2c8d128b32905a2d22fa4032d4d0497636 |
Hashes for testghacookiecutter-0.0.94-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec0927623f873c542050d546e83bd972a80b9ce21c6a9e80d497b5c449eee384 |
|
MD5 | 0d4acc382b904b35387adaff5daf353f |
|
BLAKE2b-256 | deb93b9fcbeed3208e4c8c26f399d7fa8ad24d771ee6c319556e1c6b295aa0ba |
Hashes for testghacookiecutter-0.0.94-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 47872e4de3cc0ad5703a1eb7ffa52b80f746caf1069858a5073e7236dac08bb3 |
|
MD5 | 04fd800614457136ce286240bc8aa797 |
|
BLAKE2b-256 | 4ecc59bf1a6b1380ecef3e675d17ffa9ce68dd50be787edf1ea15da0bc058b7c |
Hashes for testghacookiecutter-0.0.94-cp39-cp39-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 33351007d48fab8cd08cb8715b35698559e09e124f7623a11ad535f8cb2815cc |
|
MD5 | 61b888c76e41f41701647514247af889 |
|
BLAKE2b-256 | 31db50f5a1602e42dd6ed4328ac01e39d200c13f99d841f22a1ef65f4267639e |
Hashes for testghacookiecutter-0.0.94-cp39-cp39-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76acfda38404362bb499fd3182aea25ae60815912d286bcfc71fdd4615adb2e5 |
|
MD5 | d118c64bd8eeb1a48a7874e20b941def |
|
BLAKE2b-256 | 8d5121fba8e9d44376e6f99021b8b27abd71fd6706659e8a4e65b9a92098b951 |
Hashes for testghacookiecutter-0.0.94-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 008c5b6a4453094bd8fd821b0744a14b6c0dd0a43278fea231e63f0ff4dbd7df |
|
MD5 | 91eee711be096c8d8fb7a774920abb4e |
|
BLAKE2b-256 | 7d64f66ab1aca3927030182575227e7ef146b48dcae00a7a200c4d75f50cd3ad |
Hashes for testghacookiecutter-0.0.94-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 78e211fc2762e211d0aa231a9cc3f83c26ae2f59f24a00340b697140232a5766 |
|
MD5 | 634857c345eaeaeeee70cced05a1eaab |
|
BLAKE2b-256 | 7fe7662b8371cee63ca70da5c8e9529ced4b0e24160cfcada9f9cb2e8d077596 |
Hashes for testghacookiecutter-0.0.94-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0987452070f19bf8f58f64ea442f89ccadadee112321d60cdb74d11a5eb37fde |
|
MD5 | f6aca080cd7d43df6b8963453cf00448 |
|
BLAKE2b-256 | 51bab7c5ec3e2b627c6bbf015db2e6b39392d3e3a052695a3accee7f36b682fd |
Hashes for testghacookiecutter-0.0.94-cp38-cp38-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad1484c4c41401de34af1361e3f7c59ee5a2200862af8eb629db71139268ef0e |
|
MD5 | 837b7c429729d8ef4c865057283f2512 |
|
BLAKE2b-256 | ccc45221e63a51ed0151aeec5443ce22a61f3f2fdfb0d3d09b8924f9febe5442 |
Hashes for testghacookiecutter-0.0.94-cp38-cp38-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8f0093bf417552848808a6356d669ca80a43533215806ad04708cfa3de88959 |
|
MD5 | 83e0814d38900804a3ad866368220d90 |
|
BLAKE2b-256 | 9979077cad9ab82381e1ef4b5cb99a08d9e330b834a0dc2502590e7574d723d4 |
Hashes for testghacookiecutter-0.0.94-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b4a50203134975760ed5d9326fdc0b8f1010bdfdfe3a391261ba05f101dc200 |
|
MD5 | e07fb29813dcceccff648c79ae6ad642 |
|
BLAKE2b-256 | 595da427277befdfd724039405929edcafe15f33f2adb294e70386124a247091 |
Hashes for testghacookiecutter-0.0.94-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65ed78c805b02fc8928378483d9f494547e86634a1068ebc64dfb40cd6fa48b3 |
|
MD5 | e2e94432e8fc4d1c8d49e9ad75e7e1b5 |
|
BLAKE2b-256 | 683bffb9db86426ca9e3d9a8cd9df7f1bf1e2201a12cc6bd9b295d1694bae0f3 |
Hashes for testghacookiecutter-0.0.94-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 296d81a05ed99b4ec78ffcd107f750edd8888f0bffbe311222a081d1951abb64 |
|
MD5 | 457d9cfe5d851c3da69987242fb1543d |
|
BLAKE2b-256 | 204f0ad771f539c3f7cb0c81ec186d9bd50aca7342f3ec2c4fda163c52b845ae |