michele/DigiRadio
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Unify root docs/ with Software/docs/manual via symlink.

Browse Source 
Remove legacy DigiRadio_Manual.tex/PDF and stub main.tex; point docs/ at the
canonical manual. Update README and CONTRIBUTING paths.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
michele
2026-07-06 17:11:54 +02:00
co-authored by Cursor
parent d49b2011dd
commit 6efd6e36f7
7 changed files with 23 additions and 577 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+4 -3
View File
@@ -47,9 +47,10 @@ doxygen Doxyfile
python3 tools/check-manual-sync.py
```
The LaTeX manual (`docs/manual/`) documents design and the HTTP JSON API
(`ch-api.tex`); Doxygen documents C++ signatures. Rebuild the PDF with
`latexmk -lualatex manual.tex` inside `docs/manual/`.
The LaTeX manual lives in `Software/docs/manual/` (canonical). The repository
root `docs/` is a symbolic link to that folder for convenience and Overleaf
/GitHub browsing. Design and HTTP JSON API: `ch-api.tex`; rebuild the PDF with
`latexmk -lualatex manual.tex` inside `docs/` or `Software/docs/manual/`.
## Coding conventions