about summary refs log tree commit diff
diff options
context:
space:
mode:
authorPatryk Niedźwiedziński <pniedzwiedzinski19@gmail.com>2019-10-11 16:18:34 +0200
committerPatryk Niedźwiedziński <pniedzwiedzinski19@gmail.com>2019-10-11 16:18:34 +0200
commit0eec7534b879b795e0ed506c6de643357455fec1 (patch)
tree25fe10971769c34a7867d192a1ae1f29c2a9beef
downloadkronika-0eec7534b879b795e0ed506c6de643357455fec1.tar.gz
kronika-0eec7534b879b795e0ed506c6de643357455fec1.zip
Pierwszy commit
-rw-r--r--CONTRIBUTING.md8
-rw-r--r--README.md9
2 files changed, 17 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..75e86c9
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,8 @@
+# Kilka zasad jak pisać nowe wpisy
+
+## Lokalizacja pliku
+
+Wszystkie pliki kroniki znajdują się w folderze `wpisy`.
+
+Poszczególny wpis powinien mieć ścieżkę: `{year}/{month}/{day}/{title}.md`.
+
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3761893
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# Kronika 19 Poznańskiej Drużyny Harcerzy "Puszcza"
+
+Przed tobą znajduje się kronika 19 PDH "Puszcza" w postaci plików źródłowych. Kronika napisana jest w plikach [markdown](https://www.markdownguide.org/getting-started), które następnie są renderowane do html'u i wstawiane na naszą stronę https://puszcza.netlify.com .
+
+## Edytowanie oraz dodawanie własnych wpisów do kroniki
+
+Chcesz dodać wpis do kroniki? Albo może znalazłeś literówkę? Prześlij na adres patryk.niedzwiedzinski@zhr.pl
+
+Możesz również edytować bezpośrednio tak jak każde inne repozytorium na GitHubie (fork -> PR). Pamiętaj przy tym żeby przestrzegał naszych [zasad](./CONTRIBUTING.md).