diff --git a/README.md b/README.md new file mode 100644 index 0000000..bb98714 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# OneNightDuel +Hra pro 2 hráče inspirovaná hrou Five Nights at Freddy's. + +Dokumentace a teoretická část: `teoreticka-cast.pdf` + +Varování: hra obsahuje jumpscary + + +## Instalace +_(převzato ze sekce INSTALACE v dokumentaci)_ + +### Stažení před-kompilované aplikace + +Nevyžaduje předchozí instalaci žádných knihoven.\ +V sekci Releases (Vydání) na stránce repozitáře lze nalézt zkompilované verze programu pro Linux a Windows. Příslušný archiv je třeba pouze stáhnout a extrahovat. + +### Vlastní kompilace + +Pro případ, že by uživatel chtěl provézt kompilaci na vlastním zařízení. Vyžaduje .Net verze alespoň 9.0. Veškeré kompilační scripty jsou vytvořené pouze pro systém Linux. +Kompilaci lze provézt stažením celého repozitáře a spuštěním scriptu `build-linux.sh` – ten program zkompiluje a vytvoří odkaz na spouštěcí soubor. Scripty `build‑self‑contained-linux.sh` a `build‑self‑contained‑win.sh` slouží pro vytvoření verzí aplikace spustitelných bez předchozí instalace jakýchkoli knihoven (těch verzí, které jsou ke stažení v Releases). + +### Spuštění + +Po absolvování jednoho ze zmíněných postupů naleznete v nejvyšším adresáři spouštěcí soubor pro client nebo odkaz na něj (`OneNightDuel` ve verzi pro Linux, `OneNightDuel.bat` ve verzi pro Windows) a script pro spuštění serveru (`launch‑standalone‑server.sh`, respektive `.bat`) + +_(více informací v dokumentaci)_ \ No newline at end of file