about summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--.gitignore1
-rw-r--r--README6
-rw-r--r--README.md20
3 files changed, 21 insertions, 6 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..89ea643
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+dest
diff --git a/README b/README
deleted file mode 100644
index 0a9cdae..0000000
--- a/README
+++ /dev/null
@@ -1,6 +0,0 @@
-harcdzielnia
-============
-
-harcdzielnia to strona z listą harcerskich ubrań, które dostałem bo były już za
-małe dla druhów z drużyny. Dzięki temu można taką listę wysłać rodzicom, żeby
-nie musieli kupować nowych ciuszków.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5d8d02f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# harcdzielnia
+
+harcdzielnia to strona z listą harcerskich ubrań, które dostałem bo były już za
+małe dla druhów z drużyny. Dzięki temu można taką listę wysłać rodzicom, żeby
+nie musieli kupować nowych ciuszków.
+
+## Uruchamianie
+
+Aby wyrenderować stronę potrzebujesz `coreutils` (albo alternatywę)
+
+```
+  cd harcdzielnia
+  ./deploy.sh
+```
+
+## Jak to działa
+
+Skrypt deploy.sh jest bardzo prosty i możesz samemu zobaczyć jak on działa, ale
+w skrócie bierze on wszystkie pliki .md z folderu `itemy` i generuje na jej
+podstawie listę w index.html.