https://github.com/abdes/asap_common
A git submodule used in the asap project (https://github.com/abdes/asap). Not intended to be used separately.
https://github.com/abdes/asap_common
Last synced: 12 months ago
JSON representation
A git submodule used in the asap project (https://github.com/abdes/asap). Not intended to be used separately.
- Host: GitHub
- URL: https://github.com/abdes/asap_common
- Owner: abdes
- License: bsd-3-clause
- Created: 2018-11-17T07:33:53.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-11-27T00:45:12.000Z (over 4 years ago)
- Last Synced: 2025-01-28T03:19:21.928Z (over 1 year ago)
- Language: C++
- Size: 153 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# Common submodule for the asap project
See the asap project on [github](https://github.com/abdes/asap) for a functional
minimal starter project that uses this submodule.
This submodule is not intended to be used alone. Instead, refer to the asap
project for the recommended container to fully leverage this submodule and add other
libraries/executables/etc... to the top level project.
Functionality offered by this submodule includes:
- cmake build helpers for the end-to-end lifecycle in 'cmake' subdirectory
- assertions
- logging using spdlog
- unit testing using Catch2
- documentation using restructured text with [sphinx](http://www.sphinx-doc.org/en/master/)
- API documentation using [doxygen](http://www.doxygen.org), translated to reST using
[breathe](https://breathe.readthedocs.io/en/latest/)
## Getting the code
Refer to the asap project.
## Building
Refer to the asap project.
## Using
Refer to the documentation generated from docygen or doxygen+sphinx.