From 627f1a44d11f9bb10d09a5f6077bf8789605f3a8 Mon Sep 17 00:00:00 2001
From: archos <archos@archoslinux.cz>
Date: Fri, 4 Oct 2024 07:09:09 +0200
Subject: [PATCH] Aktualizace README souboru

---
 README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 55 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 59acbda..a9b6c65 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,57 @@
 # oscloud-docs
 
-Tento repozitář obsahuje dokumentaci a návody pro platformu OSCloud, využívající MkDocs pro snadnou správu a nasazení.
\ No newline at end of file
+Tento repozitář obsahuje dokumentaci a návody pro platformu OSCloud, využívající MkDocs pro snadnou správu a nasazení.
+
+## Přehled projektu
+
+- **Účel:** Poskytnout podrobné návody a dokumentaci k používání a správě služeb OSCloud.
+- **Technologie:** MkDocs – statický generátor stránek, který převádí soubory ve formátu Markdown na funkční a esteticky přehlednou webovou dokumentaci.
+
+## Jak začít
+
+1. **Klonování repozitáře:**
+ ```bash
+ git clone https://gitea.oscloud.cz/tvůj-uživatel/oscloud-docs.git
+```
+
+2. **Instalace MkDocs:**
+
+```bash
+pip install mkdocs
+```
+3. **Spuštění lokálně: Použij tento příkaz k spuštění MkDocs serveru a prohlížení dokumentace lokálně:**
+
+```bash
+mkdocs serve
+```
+4. **Vytvoření statických souborů: K vygenerování statických souborů pro nasazení:**
+
+```bash
+mkdocs build
+```
+## Nasazení na OSCloud pomocí LAMP
+
+1. Přístup k LAMP serveru na OSCloud: Přihlas se do LAMP aplikace přes administraci na adrese `my.oscloud.cz` a otevři terminál pro danou aplikaci.
+
+2. Instalace MkDocs na serveru: V terminálu na serveru spusť tento příkaz:
+
+```bash
+pip install mkdocs
+```
+3. *Vytvoření nového MkDocs projektu: Na serveru vytvoř nový projekt MkDocs pomocí tohoto příkazu:*
+
+```bash
+mkdocs new mysite
+```
+4. *Nahrání souborů: Nahrávej soubory projektu do kořenového adresáře LAMP aplikace pomocí FTP nebo SCP.*
+
+5. *Spuštění MkDocs serveru: Na serveru spusť MkDocs příkazem:*
+
+```bash
+mkdocs serve
+```
+Dokumentace bude dostupná na veřejné URL, kterou LAMP aplikace poskytuje.
+
+### Přispívání
+
+Neváhejte nahlásit problémy nebo přispívat úpravami a vylepšeními do dokumentace prostřednictvím pull requestů.