Overview
| PyPi module | N/A |
| git repository | https://bitbucket.org/arrizza-public/devcpp-lib-template |
| git command | git clone git@bitbucket.org:arrizza-public/devcpp-lib-template.git |
| Verification Report | https://arrizza.com/web-ver/devcpp-lib-template-report.html |
| Version Info |
|
- installation: see https://arrizza.com/setup-common
Summary
This is a template for a C++ library. It contains a set of scripts and configuration files that make creating, developing and maintaining a C++ library easier.
- See Quick Start for information on using scripts.
- See xplat.cfg to configure xplat.cfg file.
- See xplat-utils submodule for information on the submodule.
How to use
- create a git for your library
- use a diff tool like meld, and copy contents from this repo into your library.
- Use the contents as a starting point or replace completely with your library's content
Scripts
# clean it
./do_clean full # start from scratch
./do_clean # leave venv and python caches
# install it
./do_subm_update full # first time for submodules
./do_subm_update # ... thereafter
./do_install full # first time for OS and pip modules
./do_install # ...thereafter
# doc it
./do_doc # generate doxygen html and PDF
# check it
./do_check # check configs and files are okay
./do_lint # pylint or clint-tidy
./do_update # update local python modules in venv
# build it
./do_build # build using cmake (default: debug)
./do_build debug # use cmake-build-debug
./do_build release # use cmake-build-release
# run it
./doit # run the app or sample code to run the module/library (default debug)
./doit debug # use cmake-build-debug
./doit release # use cmake-build-release
./do_ver # run verification (if implemented)
./do_ut # run unit tests (if implemented)