docs: fix AGENTS.md project info and no-em-dash rule

Remove stale cuber references and unrelated static library
section. Add no-em-dash rule and apply it throughout.
This commit is contained in:
2026-05-10 01:03:32 +02:00
parent a457b5351a
commit 10c78343fe
2 changed files with 8 additions and 16 deletions
+7 -15
View File
@@ -2,7 +2,8 @@
## Project Overview
`cuber` is an OpenGL 3D renderer with multiple scenes.
`ctdd` is a C23 project wired for test-driven development using
Unity and CMock.
## Build System
@@ -27,12 +28,12 @@ Build:
ninja -C build
```
Run tests full Unity output, colored:
Run tests (full Unity output, colored):
```sh
ninja -C build check
```
Run tests CTest summary only:
Run tests (CTest summary only):
```sh
ninja -C build test
```
@@ -64,16 +65,6 @@ To add a new dependency:
2. Add `find_package(<name> REQUIRED)` to `CMakeLists.txt`
3. Link with `<name>::<name>` in `target_link_libraries()`
### Static Libraries
The project is split into static libraries:
- **`cbt_opengl`** — OpenGL abstraction and window management (window,
context, buffer, texture, vao, shader, descriptor)
- **`cbt_scene`** — Base scene class
- **`scenes_cube`** — Spinning cube scene implementation
- **`scenes_sphere`** — Cube-to-sphere mapped mesh with diffuse lighting
### CMake Module Path
`deps/` is added to `CMAKE_MODULE_PATH` so `find_package()` resolves
@@ -145,7 +136,8 @@ in HH:MM:SS.mmm format, updating every 10ms with color output.
`-` or numbered lists, fenced code blocks with language hints
(```` ```cpp ````, ```` ```sh ````).
- Keep examples concise, up-to-date, and self-documenting.
- Each shell command gets its own fenced code block — do **not** combine
- Do not use em dashes (``). Use a colon or rewrite the sentence.
- Each shell command gets its own fenced code block; do **not** combine
multiple commands into one block. Precede each block with a short
plain-text label describing what the command does:
@@ -162,7 +154,7 @@ in HH:MM:SS.mmm format, updating every 10ms with color output.
ctdd/
str.h / str.c Pure string utilities (no dependencies)
report.h / report.c Formats a value and calls log_message()
logger.h / logger.c Real log_message printf to stdout
logger.h / logger.c Real log_message via printf to stdout
main.c Entry point
tests/
test_str.c Unity state-based tests for ctdd/str