Compare commits
2 Commits
4269f65942
..
trunk
| Author | SHA1 | Date | |
|---|---|---|---|
| 8d6483eb80 | |||
| de64c90a6d |
@@ -26,6 +26,56 @@ For committing, tagging, and branching, load the `git` skill with
|
||||
Dependencies are managed via custom `Find*.cmake` scripts in `deps/`.
|
||||
See `/skill:cmake` for adding new dependencies.
|
||||
|
||||
## Build
|
||||
|
||||
Configure:
|
||||
|
||||
```sh
|
||||
cmake -S . -B build -G Ninja
|
||||
```
|
||||
|
||||
Build:
|
||||
|
||||
```sh
|
||||
ninja -C build
|
||||
```
|
||||
|
||||
Run tests (full Unity output):
|
||||
|
||||
```sh
|
||||
ninja -C build check
|
||||
```
|
||||
|
||||
Run tests (CTest summary only):
|
||||
|
||||
```sh
|
||||
ninja -C build test
|
||||
```
|
||||
|
||||
Configure with coverage:
|
||||
|
||||
```sh
|
||||
cmake -S . -B build-cov -G Ninja -DENABLE_COVERAGE=ON
|
||||
```
|
||||
|
||||
Generate coverage report:
|
||||
|
||||
```sh
|
||||
ninja -C build-cov coverage
|
||||
```
|
||||
|
||||
Open `build-cov/coverage/index.html` in a browser to view results.
|
||||
|
||||
Run the application:
|
||||
|
||||
```sh
|
||||
./build/main
|
||||
```
|
||||
|
||||
On Windows use `./build/main.exe`.
|
||||
|
||||
See `/skill:cmake` for coverage and sanitizer details.
|
||||
|
||||
## Coding Conventions
|
||||
|
||||
### C
|
||||
|
||||
@@ -8,6 +8,16 @@ template when scaffolding new projects.
|
||||
All dependencies are fetched automatically via CMake `FetchContent` with no
|
||||
manual installation required beyond the tools listed below.
|
||||
|
||||
## License
|
||||
|
||||
This template is licensed under the MIT License. The license covers the
|
||||
CMake build files, `deps/` scripts, and other template infrastructure.
|
||||
|
||||
Because this is a project template, your own source code is not bound by
|
||||
this license. You are free to choose any license for your project that is
|
||||
compatible with MIT. Simply replace the `LICENSE` file with your chosen
|
||||
license.
|
||||
|
||||
## Requirements
|
||||
|
||||
| Tool | Purpose |
|
||||
|
||||
Reference in New Issue
Block a user