forked from k0gen/Veritaryzm
46 lines
2.5 KiB
Markdown
46 lines
2.5 KiB
Markdown
|
# Veritaryzm - projekt książki
|
||
|
|
|
||
|
|
Repozytorium pracy nad książką o Veritaryzmie. Wszystko w **Markdown** dla wygody edycji i późniejszego eksportu (PDF, HTML, e-book).
|
||
|
|
|
||
|
|
## Zawartość
|
||
|
|
|
||
|
|
| Element | Opis |
|
||
|
|
|--------|------|
|
||
|
|
| **[PLAN_KSIAZKI.md](PLAN_KSIAZKI.md)** | Plan książki: struktura, spis treści, zasady pracy, pytania do doprecyzowania |
|
||
|
|
| **metadata.yaml** | Metadane: tytuł, autor, język, styl |
|
||
|
|
| **pandoc-template.tex** | Formatowanie: stopki, nagłówki, styl (`just check-template` do testów bez PDF) |
|
||
|
|
| **src/** | Tekst książki - jeden plik `.md` = jeden rozdział lub logiczny blok |
|
||
|
|
| **veritaryzm.txt** | Oryginalny zbiór zapisków i myśli (źródło do rozłożenia na rozdziały) |
|
||
|
|
|
||
|
|
## Jak pracować
|
||
|
|
|
||
|
|
1. **Planowanie** - w razie zmian w strukturze edytuj `PLAN_KSIAZKI.md` i ewentualnie `src/SPIS_TRESCI.md`.
|
||
|
|
2. **Pisanie** - edytuj pliki w `src/` (np. `src/04_kodeks_etyczny.md`). Nagłówki w Markdown (`#`, `##`, `###`) ułatwią późniejszy spis treści i eksport.
|
||
|
|
3. **Źródło** - treść do przeniesienia lub rozwinięcia bierz z `veritaryzm.txt` (plik roboczy dla autorów). W plikach w `src/` nie umieszczaj wzmianek o `veritaryzm.txt` - tekst książki jest wyłącznie dla czytelnika.
|
||
|
|
4. **Szablon LaTeX** - przy zmianach w `pandoc-template.tex` uruchom `just check-template` (generuje .tex bez PDF).
|
||
|
|
5. **Wersjonowanie** - przy użyciu Git każdy plik `.md` można śledzić osobno; sensowne commity: „Rozdział 4 - pierwszy szkic”, „Księga Luster - rozbudowa Pułapki Echa”.
|
||
|
|
|
||
|
|
## Praca z Git
|
||
|
|
|
||
|
|
Repozytorium jest gotowe do wersjonowania: historia commitów pozwala śledzić zmiany w planie, rozdziałach i notatkach.
|
||
|
|
|
||
|
|
- **Po zmianach** (rozdziały, plan, `_notatki_pomocnicze.md`):
|
||
|
|
```bash
|
||
|
|
git add .
|
||
|
|
git status # sprawdź, co trafia do commita
|
||
|
|
git commit -m "Krótki opis: np. Rozdział 02 - uzupełnienie pięciu filarów"
|
||
|
|
```
|
||
|
|
- **Źródło `veritaryzm.txt`** - traktowane jako archiwum; ewentualne zmiany warto commitować osobno (np. „veritaryzm.txt: poprawki pisowni”).
|
||
|
|
- **Notatki robocze** - plik `_notatki_pomocnicze.md` możesz włączać do commitów razem z rozdziałami lub osobno.
|
||
|
|
|
||
|
|
Szczegóły zasad projektu i nawigacji: [.cursor/instructions.md](.cursor/instructions.md).
|
||
|
|
|
||
|
|
## Eksport (później)
|
||
|
|
|
||
|
|
- **Markdown → PDF/HTML:** np. Pandoc, MkDocs, Obsidian Export, lub edytor z eksportem (Typora, VS Code + rozszerzenia).
|
||
|
|
- **Jedna wielka składanka:** `cat src/*.md > calosc.md` (po ewentualnym usunięciu powtórzeń nagłówków).
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
*Veritas vos liberabit.*
|