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.87-cp310-cp310-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3d501731d1329987d2708d054a1721ae861b751b0ecec7092adccdc624bb90b0 |
|
MD5 | 06eb3533034eef05dd7b2ffd9ca0c16f |
|
BLAKE2b-256 | 60a2badb2339ee2db1326caebe5904ba90370fa6d4d7279c823ecd0b660e1d13 |
Hashes for testghacookiecutter-0.0.87-cp310-cp310-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e5a54f4cfc8b51b503ab9be95b6d6fbb318f63e64028b624c907f698a6964d5f |
|
MD5 | 8ac019dcb8d34b258d8afee998db6f7e |
|
BLAKE2b-256 | be70ca695a72cfc91d1edaeaad58607dd3ea7a3d19e124dd2a7d28602649e783 |
Hashes for testghacookiecutter-0.0.87-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83f58775c3c528244334429212a218e29b1dca87a5daffeee0714e69b0d6770c |
|
MD5 | f17db9681fdd086dd9585135309eddb0 |
|
BLAKE2b-256 | 8f751a751557eeeeda2458c35ad6633be06d292a828e2b386dde8330e3241bab |
Hashes for testghacookiecutter-0.0.87-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7d182b8f2265e5aff2659db134de424341947f86c8772f7be3d3c9184a485ca |
|
MD5 | 96b4ac14636c25b1b28211654ba5c55a |
|
BLAKE2b-256 | 4010a27ed2acc24afb72e7125f51ea615192dd43f921aa8eeaa326595e7341d0 |
Hashes for testghacookiecutter-0.0.87-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b52887e85f9b1d3949c4beead87fa23aa4997e6d506ab7c4aa243de7c077c4e |
|
MD5 | 4853949bac90500c5bc6dc4c78a88a29 |
|
BLAKE2b-256 | 9d3d8e801112f3c9ddf3fbb53c6225635daee7cd5652808c39fc963a5ee4b8e1 |
Hashes for testghacookiecutter-0.0.87-cp39-cp39-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e53b1d51abf3cb63bad8302253f633455cfd176ab7a5cbe6c7ef33386e9fd87 |
|
MD5 | bb2cbfc55b5468823ba5ac2727be0d74 |
|
BLAKE2b-256 | 796e9ca8bf58d08665d6f892d7ab752db31a1f6379868ad4e5bd3fd25d2b4cc2 |
Hashes for testghacookiecutter-0.0.87-cp39-cp39-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 313a6feaedc6b68aac50de32a7714f0a55801a8f07ec6d292a0439e54af41937 |
|
MD5 | 7e4e71235d5c06e9862d46f4ddef2d40 |
|
BLAKE2b-256 | 8b69118f6a059a202ab73ca3ef922926ddbac5cded0211071c85e88d491c6557 |
Hashes for testghacookiecutter-0.0.87-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40e2401c700361b4c19ae5ed756b9a80d1bbc98cbd126c52acf6f3c5a808f71d |
|
MD5 | d3a3052473e3a4d708326243f50fefd5 |
|
BLAKE2b-256 | 223c08bdeb57cfddfb32c89c8780f306f1dfc17bdd1705167fff4914c5ad548e |
Hashes for testghacookiecutter-0.0.87-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef26047d23ad8ab93ea5b2bac78d8446ce06d5ded42a32fd60387609b8c39729 |
|
MD5 | dec6880bb8cea775fa7f084a42b26c94 |
|
BLAKE2b-256 | 1988485f574e0e09ad400c94dc3cd6971bdcd66705975aad82e2f13bbae62ba5 |
Hashes for testghacookiecutter-0.0.87-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c4cbeb212157e727081c391e2744a19d774208ac08801d263d347db4032ddb89 |
|
MD5 | 941adffe9dfd635c5e4e4c6fe059d3eb |
|
BLAKE2b-256 | cca463c012f8b2281e9ab3d4bc5fd24f76a498ddbfc73fc60f47aac4a960417c |
Hashes for testghacookiecutter-0.0.87-cp38-cp38-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fbf2a8e9ecd5720aba09ebe8a774059a093704ba822a9d475401e80e1f793a1a |
|
MD5 | a9e38cbf0d1306da080d71c39dcbfeaf |
|
BLAKE2b-256 | 043e3c83c5be77caebcdd1073881d1c3d354b1adf825b573d48fc319c8ace99d |
Hashes for testghacookiecutter-0.0.87-cp38-cp38-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 062ed0dac100c8d11ce53363c2d18512afc2864ea660fa3cea283fe55ddfd444 |
|
MD5 | c0b1b1cb5e6e63375085cc3ab77fe1c1 |
|
BLAKE2b-256 | 4f82e1ad1b21bdc7bbfb930c2291456428010516e9fb0978023ff447420e9b35 |
Hashes for testghacookiecutter-0.0.87-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3fe578278a1ee8f4340ed5f84a13cc53082068ce1c88622f4083fe77a4743c82 |
|
MD5 | 43f98eded244af10f08e667d00a80211 |
|
BLAKE2b-256 | e20624df1358707650c07939f48845366a70c9641dcca88383625f5c97f74f5e |
Hashes for testghacookiecutter-0.0.87-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 370827261edfdf5f7a320cc83bf09c41cc69ad30524e11e2661821cbf1f657f9 |
|
MD5 | a71413e0b85a74d94f00cbb948b2423e |
|
BLAKE2b-256 | 53b1f401922e1d4ffcef00ca93ff66bcf5b469623d2935f538620c567cd706e7 |
Hashes for testghacookiecutter-0.0.87-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2bd05760ca51ade733e45ba7413905db2f8e0ba578fb65bdb23644010e0b528 |
|
MD5 | 84a0947575f443c59b34df6e7a5725f6 |
|
BLAKE2b-256 | b01e298c51391a7ae0da706fa3125f437a0574369ebfaa17b5dc315a2c5e84ab |