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
WHERE-TO-PUT-THESE.md
+7 -4
View File
@@ -17,17 +17,20 @@ DigiRadio/ <- repo root
├── tools/
│ └── check-manual-sync.py enforces "a section per public class"
└── docs/
└── manual/ the technical manual (LaTeX)
└── manual/ the technical manual (LaTeX) — canonical
├── manual.tex main file
├── digiradio-manual.sty style (Optima-like, boxes, listings)
├── ch-*.tex chapters
└── manual.pdf compiled preview
At the **repository root**, `docs/` is a **symbolic link** to
`Software/docs/manual/` (one source of truth; do not duplicate .tex here).
```
## Build the manual
cd Software/docs/manual
latexmk -lualatex manual.tex # real Optima on macOS
# or: pdflatex manual.tex x3 # Biolinum fallback
cd docs # symlink → Software/docs/manual
latexmk -lualatex manual.tex # real Optima on macOS
# or: cd Software/docs/manual && latexmk -lualatex manual.tex
## Enforcement in CI (run from Software/)
doxygen Doxyfile # API docs must pass