diff options
| -rw-r--r-- | CONTRIBUTING.md | 8 | ||||
| -rw-r--r-- | README.md | 9 |
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). |