https://github.com/mrpossoms/clbp
C library boiler-plate
https://github.com/mrpossoms/clbp
boilerplate c code-formatter documentation-generator github-actions makefile unittest
Last synced: 10 months ago
JSON representation
C library boiler-plate
- Host: GitHub
- URL: https://github.com/mrpossoms/clbp
- Owner: mrpossoms
- Created: 2021-02-10T14:19:13.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-02-10T14:43:53.000Z (almost 5 years ago)
- Last Synced: 2025-01-30T15:46:50.212Z (12 months ago)
- Topics: boilerplate, c, code-formatter, documentation-generator, github-actions, makefile, unittest
- Language: Makefile
- Homepage:
- Size: 48.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# clbp
C Library Boilerplate is a starting point for C/C++ library projects and includes a functionally minimal makefile, dependency management tooling config, directory structures, automatic code formatting, and unit testing infrastructure.
## Requirements
To best utilize this boilerplate please ensure you have installed the following
* Python3+
* Pip
* C/C++ toolchain
* GNU make
* doxygen
* clang-format
## Dependencies
Instead of managing dependencies as git submodules. A seperate python program
called [gitman](https://github.com/jacebrowning/gitman) which does an excellent
job managing, updating and even building dependencies. If you have a proper
python3 and pip environment setup then gitman will be installed automatically.
## Useage
The Makefile included at the repository root can be used to do almost
everything you could want to do. This includes fetching, installing and
building dependencies, building documentation and of course the software
itself. Helpful make rules include the following.
* `static` - Build project as a static library.
* `shared` - Build project as a shared library .
* `test` - Build and run the test suite
* `format` - Run clang-format explicitly (normally executed as a pre-commit
hook).
* `docs` - Run Doxygen and build documentation.
* `deps` - Edit depenedency config file
* `deps-update` - Pull the latest versions of all dependencies.
* `clean` - Delete all build artifacts.