forked from k0gen/Veritaryzm
55 lines
2.9 KiB
Markdown
55 lines
2.9 KiB
Markdown
|
# Instrukcje projektu: Książka o Veritaryzmie
|
|||
|
|
|
|||
|
|
Kontekst dla pracy nad książką w tym repozytorium.
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## Cel projektu
|
|||
|
|
|
|||
|
|
Książka przedstawiająca **Veritaryzm** jako kompletny, spójny system - od filozofii przez etykę, strukturę, praktykę, relacje zewnętrzne i wychowanie kolejnych pokoleń. Docelowy odbiorca: poszukiwacze, sceptycy, osoby zainteresowane „religią bez dogmatów”.
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## Struktura repozytorium
|
|||
|
|
|
|||
|
|
| Ścieżka | Opis |
|
|||
|
|
|--------|------|
|
|||
|
|
| `metadata.yaml` | Metadane: tytuł, autor, język, styl |
|
|||
|
|
| `pandoc-template.tex` | Formatowanie: stopki, nagłówki, styl (zmiany testować przez `just check-template`) |
|
|||
|
|
| `src/` | Treść książki: rozdziały (00–24) i spis treści - pliki .md wchodzące do eksportu |
|
|||
|
|
| `PLAN_KSIAZKI.md` | Główny plan: struktura, metadane, odpowiedzi na pytania autorskie |
|
|||
|
|
| `src/SPIS_TRESCI.md` | Spis treści z linkami; wersja „bestsellerowa” z obietnicami |
|
|||
|
|
| `_notatki_pomocnicze.md` | Materiał roboczy dla autorów: pytania, cytaty, słownik, pomysły - nie wchodzi do eksportu książki |
|
|||
|
|
| `veritaryzm.txt` | **Archiwum surowe** - materiał źródłowy; nie edytować w ramach rozwoju książki. Treść książki rozwija się wyłącznie w plikach `.md` w `src/`. |
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## Zasady pisania
|
|||
|
|
|
|||
|
|
1. **Źródło treści:** Rozkładanie i rozwijanie materiału z `veritaryzm.txt` do odpowiednich rozdziałów w `src/*.md`. Nowe sformułowania i aktualizacje - tylko w plikach `.md`.
|
|||
|
|
2. **Myślnik:** Zawsze używać zwykłego myślnika `-` (minus/hyphen). Nigdy nie używać em dash `-`.
|
|||
|
|
3. **Ton:** Jasny, logiczny, unikający języka sekciarskiego; miejsce na refleksję i pytania; obietnica konkretu (narzędzia, zasady, praktyki), nie tylko idei.
|
|||
|
|
4. **Rozdział:** Jedno główne przesłanie + jedno „zabierz ze sobą” (zasada, pytanie lub ćwiczenie). Zwięzły rdzeń; 1–2 rozwinięcia lub przykłady tam, gdzie to wzbogaca.
|
|||
|
|
5. **Tytuły w spisie:** Zgodne z `PLAN_KSIAZKI.md` (wersja bestsellerowa); tytuły części i rozdziałów formułują obietnicę lub pytanie.
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## Nawigacja
|
|||
|
|
|
|||
|
|
- **Plan i spis:** `PLAN_KSIAZKI.md`, `src/SPIS_TRESCI.md`
|
|||
|
|
- **Numeracja rozdziałów:** `00_wprowadzenie.md` … `24_proklamacja.md` - zachować spójność nazw plików i linków w spisie.
|
|||
|
|
- **Notatki robocze:** `_notatki_pomocnicze.md` - słownik pojęć, pytania otwarte, cytaty, pomysły na przykłady (dla wszystkich autorów).
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## Wersjonowanie (Git)
|
|||
|
|
|
|||
|
|
- Commity opisowe (np. „Rozdział 02: uzupełnienie filarów”, „Spis: nowe tytuły części”).
|
|||
|
|
- `veritaryzm.txt` - tylko odczyty w ramach pracy nad książką; zmiany w nim (jeśli kiedykolwiek) traktować jako osobne, świadome commity archiwum.
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
**pandoc-template.tex:** Przy pracy nad szablonem uruchom `just check-template` - generuje .tex bez PDF, do weryfikacji zmian bez pełnej kompilacji.
|
|||
|
|
|
|||
|
|
*Zaktualizuj ten plik, gdy zmienią się zasady projektu lub struktura.*
|