Merge pull request 'release: v0.2.0' (#28) from version/v0.2.0 into main

Reviewed-on: david/kostky#28

.gitignore

@@ -0,0 +1,5 @@
+__pycache__/
+*.pyc
+dist/
+build/
+*.egg-info/

README.md

@@ -1,2 +1,100 @@
 # kostky
 
+Textová (CLI) hra v kostky pro více hráčů – varianta klasického *Farkle*
+(„tisícovky“). Běží celá v terminálu, v Pythonu, s jedinou závislostí
+(`tabulate` pro závěrečnou výsledkovou tabulku).
+
+## Požadavky
+
+- Python 3.9+
+- Závislost `tabulate` (doinstaluje se automaticky při instalaci)
+
+## Instalace a spuštění
+
+```bash
+git clone https://gitea.spacilovi.eu/david/kostky.git
+cd kostky
+pip install .
+kostky
+```
+
+Případně bez instalace (s nainstalovaným `tabulate`) přes `python -m kostky`,
+nebo izolovaně jako CLI nástroj přes `pipx install .`.
+
+> Pro vývoj: `pip install -e ".[dev]"` – editovatelná instalace včetně `mypy`
+> a `ruff`.
+
+## Jak se hraje
+
+### Začátek hry
+
+1. Zadej jméno prvního hráče (povinné, nesmí být prázdné).
+2. Přidávej další hráče; zadáním `x` zadávání ukončíš. Jména musí být unikátní.
+3. Zadej cílové skóre, nebo nech pole prázdné pro výchozích **10 000**.
+
+### Průběh tahu
+
+Na začátku tahu uvidíš, kdo je na tahu (s jeho skóre a cílem), a hod šesti
+kostkami s písmennými pozicemi:
+
+```
+Na tahu je Anna (0/10000).
+1, 5, 3, 2, 6, 4
+^  ^  ^  ^  ^  ^
+a  b  c  d  e  f
+```
+
+Pak zvolíš jednu z akcí:
+
+| Vstup | Akce |
+| --- | --- |
+| `pozice kostek` | Odložíš vybrané kostky k vyhodnocení – písmeny (např. `a`, `cd`, `abcdef`). Hodnoty na zvolených pozicích musí dohromady tvořit některou kombinaci z bodovací tabulky. |
+| `h` | Hodíš znovu zbývajícími kostkami. Povoleno až poté, co v tomto tahu odložíš aspoň jednu bodující kombinaci. |
+| `k` | Ukončíš tah, připíšeš si nasbírané skóre a předáš tah dalšímu hráči. |
+| `exit` | Předčasně ukončíš celou hru. |
+
+Odkládat můžeš i víc kombinací po sobě – po každém vyhodnocení pokračuješ se
+zbývajícími kostkami a body se v rámci tahu sčítají.
+
+### Smůla, hot dice, vynulování a výhra
+
+- **Smůla (bust):** když čerstvý hod neobsahuje žádnou bodující kombinaci,
+  o body z tohoto tahu přijdeš a tah přechází na dalšího hráče.
+- **Hot dice:** když se ti podaří odložit všech šest kostek, dostaneš čerstvý
+  hod šesti kostkami a pokračuješ ve stejném tahu.
+- **Vynulování:** tři po sobě jdoucí nulové tahy vynulují tvé celkové skóre.
+  Počet aktuálních nul se vedle skóre ukazuje jako `x` / `xx`.
+- **Výhra:** po dokončení každého kola vyhrává osamocený lídr nad cílovým
+  skóre; při shodě na první příčce se hraje dál. Na konci se vypíše výsledková
+  tabulka s pořadím všech hráčů.
+
+## Bodování
+
+Kompletní tabulka je v souboru [`kostky/hodnoty.csv`](kostky/hodnoty.csv).
+Kombinace se vyhodnocuje podle hodnot odložených kostek – na jejich pořadí
+nezáleží.
+
+### Stejné kostky
+
+| Kostka | ×1 | ×2 | ×3 | ×4 | ×5 | ×6 |
+| --- | --- | --- | --- | --- | --- | --- |
+| **1** | 100 | 200 | 1000 | 2000 | 4000 | 8000 |
+| **2** | – | – | 200 | 400 | 800 | 1600 |
+| **3** | – | – | 300 | 600 | 1200 | 2400 |
+| **4** | – | – | 400 | 800 | 1600 | 3200 |
+| **5** | 50 | – | 500 | 1000 | 2000 | 4000 |
+| **6** | – | – | 600 | 1200 | 2400 | 4800 |
+
+(„–“ = daná kombinace samostatně neboduje.)
+
+### Postupky
+
+| Kombinace | Body |
+| --- | --- |
+| 1-2-3-4-5 | 750 |
+| 2-3-4-5-6 | 1000 |
+| 1-2-3-4-5-6 | 1500 |
+
+## Licence
+
+Projekt je licencovaný pod [GPL-3.0](LICENSE).

kostky/__main__.py

@@ -0,0 +1,4 @@
+from kostky.kostky import main
+
+if __name__ == "__main__":
+    main()