portersky/ctdd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: remove em dashes from README

Browse Source
This commit is contained in:
portersky
2026-06-15 00:50:46 +02:00
parent e9bdd3bff5
commit 7fbc4a49c5
1 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+16 -8
View File
@@ -4,27 +4,29 @@ A C23 project wired for test-driven development using
[Unity](https://github.com/ThrowTheSwitch/Unity) and [Unity](https://github.com/ThrowTheSwitch/Unity) and
[CMock](https://github.com/ThrowTheSwitch/CMock). [CMock](https://github.com/ThrowTheSwitch/CMock).
All dependencies are fetched automatically via CMake `FetchContent` — no All dependencies are fetched automatically via CMake `FetchContent` with no
manual installation required beyond the tools listed below. manual installation required beyond the tools listed below.
## Requirements ## Requirements
| Tool | Purpose | | Tool | Purpose |
| ------------ | ----------------------------------------------------- | | ------------ | ---------------------------------------------------- |
| CMake ≥ 3.21 | Build system | | CMake ≥ 3.21 | Build system |
| Ninja | Build backend | | Ninja | Build backend |
| C23 compiler | GCC 14+, Clang 18+ | | C23 compiler | GCC 14+, Clang 18+ |
| Ruby ≥ 3.0 | CMock mock generation | | Ruby ≥ 3.0 | CMock mock generation |
| gcovr ≥ 6.0 | Coverage reports — optional (`uv tool install gcovr`) | | gcovr ≥ 6.0 | Coverage reports, optional (`uv tool install gcovr`) |
## Build ## Build
Configure: Configure:
```sh ```sh
cmake -S . -B build -G Ninja cmake -S . -B build -G Ninja
``` ```
Build: Build:
```sh ```sh
ninja -C build ninja -C build
``` ```
@@ -32,11 +34,13 @@ ninja -C build
## Test ## Test
Full Unity output with colors: Full Unity output with colors:
```sh ```sh
ninja -C build check ninja -C build check
``` ```
CTest summary only: CTest summary only:
```sh ```sh
ninja -C build test ninja -C build test
``` ```
@@ -48,11 +52,13 @@ binaries by hand.
## Coverage ## Coverage
Configure with coverage instrumentation: Configure with coverage instrumentation:
```sh ```sh
cmake -S . -B build-cov -G Ninja -DENABLE_COVERAGE=ON cmake -S . -B build-cov -G Ninja -DENABLE_COVERAGE=ON
``` ```
Generate the HTML report: Generate the HTML report:
```sh ```sh
ninja -C build-cov coverage ninja -C build-cov coverage
``` ```
@@ -70,11 +76,13 @@ mock files are excluded. Requires GCC or Clang with gcov support, and
## Run ## Run
Windows: Windows:
```sh ```sh
./build/main.exe ./build/main.exe
``` ```
Linux / macOS: Linux / macOS:
```sh ```sh
./build/main ./build/main
``` ```