43 lines
1.3 KiB
Markdown
43 lines
1.3 KiB
Markdown
|
# Nimcheck — project notes
|
||
|
|
|
||
|
|
## Standing task
|
||
|
|
|
||
|
|
Keep `README.md`, this file, and the test suite aligned with the current
|
||
|
|
implementation. Update all that apply together when any one changes.
|
||
|
|
|
||
|
|
## README policy
|
||
|
|
|
||
|
|
`README.md` is product-facing: concise overview, capabilities, quick start, build,
|
||
|
|
test, structure, documentation links. No badges, no contribution appeals, no
|
||
|
|
embedded API reference (that lives under `docs/`).
|
||
|
|
|
||
|
|
## Configuration
|
||
|
|
|
||
|
|
No `.env.json` or environment-based configuration. Nimcheck runs with defaults
|
||
|
|
after `nimble build`; no setup step required.
|
||
|
|
|
||
|
|
## Testing
|
||
|
|
|
||
|
|
- Framework: Nim `unittest` via `tests/test_all.nim`
|
||
|
|
- Run: `make test` or `nimble test`
|
||
|
|
- Single language: `nim c -r tests/test_<lang>.nim`
|
||
|
|
- Lint: `make lint`
|
||
|
|
- Coverage: `make coverage` (optional; requires nimcoverage)
|
||
|
|
|
||
|
|
## Repository
|
||
|
|
|
||
|
|
- Default branch: `master`
|
||
|
|
- CI: `.gitea/workflows/ci.yml` — see `docs/GITEA.md`
|
||
|
|
- Remote: `https://retoor.molodetz.nl/retoor/nimcheck.git`
|
||
|
|
|
||
|
|
## Documentation map
|
||
|
|
|
||
|
|
| File | Role |
|
||
|
|
|------|------|
|
||
|
|
| `README.md` | Overview and quick start |
|
||
|
|
| `docs/API.md` | API, types, JSON, CLI |
|
||
|
|
| `docs/ERRORS.md` | Error codes and per-language triggers |
|
||
|
|
| `docs/ARCHITECTURE.md` | Pipeline layers |
|
||
|
|
| `docs/STATUS.md` | Release status |
|
||
|
|
| `docs/GITEA.md` | CI and branch policy |
|
||
|
|
| `CONTRIBUTING.md` | Development workflow |
|