From 0e79152757abe8db17f7aac12e3306585113c8f6 Mon Sep 17 00:00:00 2001
From: Lukas Krupcik <lukas.krupcik@vsb.cz>
Date: Tue, 19 Jul 2016 08:22:37 +0200
Subject: [PATCH] Update README.md

---
 README.md | 43 ++++++++++++++++++++++++++++---------------
 1 file changed, 28 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 5b4f7ed8c..87d0328a0 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,37 @@
-### Převod html dokumentace do md formátu
+# Převod html dokumentace do md formátu
 
-* stáhne soubory (html, jpg, png, ...)
-```
-html_md.sh -w
-```
+## CĂ­l
 
-* převede html do md, vytvoří složku info, kde se evidují odkazy na soubory ve složkách
-```
-html_md.sh -c
-```
+Výsledkem projektu by měl být skript pro stažení a převod stávající dokumentace na docs.it4i.cz do md formátu
 
-* odstraní všechny html soubory
-```
-html_md.sh -d -html
-``` 
+## Základní požadavky
+
+* stažení celé adresářové struktury docs.it4i.cz
+* konverze html souborĹŻ na md soubory
+* zachování stejného formatování jako na webu
+
+## Postup
 
-* odstraní všechny md soubory
+Pro svou práci si naklonujete Gitem repozitář do svého pracovního adresáře.
+
+### Funkce skriptu
+
+StaĹľenĂ­ souborĹŻ:
+
+```bash
+$ ./html_md.sh -w
 ```
-html_md.sh -d -md 
+
+### Konverze html do md
+
+```bash
+$ ./html_md.sh -c
 ```
 
+### Smazání html/md souborů
 
+```bash
+$ ./html_md.sh -d -html
+$ ./html_md.sh -d -md
+```
 
-- 
GitLab