summary refs log tree commit diff
diff options
context:
space:
mode:
authorPatryk Niedźwiedziński <pniedzwiedzinski19@gmail.com>2019-10-14 22:00:03 +0200
committerGitHub <noreply@github.com>2019-10-14 22:00:03 +0200
commitdcb1b0fbbeb24fd253c8bf8713b793c6a81f7e24 (patch)
tree2d793158a1a4fc67f3f7689612347e6971247e31
parent8dda31c2a924521accdcdb633ebf2e7dc56955a0 (diff)
parent8ebe9717e25cb578426ac452bcac3808671f3c24 (diff)
downloadkronikarz-dcb1b0fbbeb24fd253c8bf8713b793c6a81f7e24.tar.gz
kronikarz-dcb1b0fbbeb24fd253c8bf8713b793c6a81f7e24.zip
Merge pull request #1 from pniedzwiedzinski/develop
Add more info to README
-rw-r--r--EXPLANATION.md20
l---------[-rw-r--r--]README.md21
2 files changed, 21 insertions, 20 deletions
diff --git a/EXPLANATION.md b/EXPLANATION.md
new file mode 100644
index 0000000..b26515c
--- /dev/null
+++ b/EXPLANATION.md
@@ -0,0 +1,20 @@
+# kronikarz
+
+### !!! To repozytorium to prototyp mojej idei prowadzenia kroniki elektronicznej. Jestem w trakcie jego wprowadzania dlatego nie jestem jeszcze w stanie powiedzieć czy jest on skuteczny.
+
+Podczas tworzenia kroniki drużyny napotkałem kilka dylematów: gdzie ją przechowywać, jak ją przechowywać i wreszcie: czy za 10 lat podjąłbym taką samą decyzję?
+
+Te przemyślenia doprowadziły mnie do takiej konkluzji:
+
+1. Kronika elektroniczna powinna być niezależna od środowiska. - Powinna móc być otworzona na komputerze jak i na telefonie, na macu, linuxie i windowsie.
+2. Powinna być łatwa do skopiowania / przeniesienia - Kronika powinna być łatwo udostępnialna. Kronika powinna również mieć robione kopie zapasowe. Szkoda by było gdyby tyle lat kronikarskiej pracy przepadło bez śladu.
+3. Można zsynchronizować z Facebookiem - Po co pisać dwa razy w dwóch miejscach? Nie lepiej jeśli wybrane wpisy automatycznie dodawały się na fanpage?
+
+Te wymagania skłoniły mnie aby stworzyć system elektronicznej kroniki opartej na systemie plików - coś co każde urządzenie ma. Ponadto jako programista oparłem moją kronikę na systemie kontroli wersji git, który połączony z GitHubem zapewnia mi kopie zapasową a także system dystrybucji surowych danych. 
+
+Surowych? Tak, ponieważ założeniem było oddzielenie wyglądu od treści, dlatego żadne `pdfy` nie wchodziły w grę. Mógłbym zapisywać treści wpisów w plikach `.txt` ale stwierdziłem że potrzebuję jakiegoś sposobu formatowania tekstu. Wybór padł na Markdown, którego składnia jest względnie prosta do nauczenia nawet dla osoby mało technicznej.
+
+No to co z wyglądem? I dlatego właśnie jesteśmy w tym repozytorium, którego właśnie celem jest umożliwienie dostępu do plików przez proste API. Dzięki temu będziesz mógł wyświetlić swoją kronikę w sposób jaki TY chcesz.
+
+Jeśli chodzi o Facebooka to jedynym rozwiązaniem byłoby użycie Instant Articles połączonych z RSS'em na stronce. Nie jest to rozwiązanie idealne ale całkiem niezłe.
+
diff --git a/README.md b/README.md
index b26515c..0e01b43 100644..120000
--- a/README.md
+++ b/README.md
@@ -1,20 +1 @@
-# kronikarz
-
-### !!! To repozytorium to prototyp mojej idei prowadzenia kroniki elektronicznej. Jestem w trakcie jego wprowadzania dlatego nie jestem jeszcze w stanie powiedzieć czy jest on skuteczny.
-
-Podczas tworzenia kroniki drużyny napotkałem kilka dylematów: gdzie ją przechowywać, jak ją przechowywać i wreszcie: czy za 10 lat podjąłbym taką samą decyzję?
-
-Te przemyślenia doprowadziły mnie do takiej konkluzji:
-
-1. Kronika elektroniczna powinna być niezależna od środowiska. - Powinna móc być otworzona na komputerze jak i na telefonie, na macu, linuxie i windowsie.
-2. Powinna być łatwa do skopiowania / przeniesienia - Kronika powinna być łatwo udostępnialna. Kronika powinna również mieć robione kopie zapasowe. Szkoda by było gdyby tyle lat kronikarskiej pracy przepadło bez śladu.
-3. Można zsynchronizować z Facebookiem - Po co pisać dwa razy w dwóch miejscach? Nie lepiej jeśli wybrane wpisy automatycznie dodawały się na fanpage?
-
-Te wymagania skłoniły mnie aby stworzyć system elektronicznej kroniki opartej na systemie plików - coś co każde urządzenie ma. Ponadto jako programista oparłem moją kronikę na systemie kontroli wersji git, który połączony z GitHubem zapewnia mi kopie zapasową a także system dystrybucji surowych danych. 
-
-Surowych? Tak, ponieważ założeniem było oddzielenie wyglądu od treści, dlatego żadne `pdfy` nie wchodziły w grę. Mógłbym zapisywać treści wpisów w plikach `.txt` ale stwierdziłem że potrzebuję jakiegoś sposobu formatowania tekstu. Wybór padł na Markdown, którego składnia jest względnie prosta do nauczenia nawet dla osoby mało technicznej.
-
-No to co z wyglądem? I dlatego właśnie jesteśmy w tym repozytorium, którego właśnie celem jest umożliwienie dostępu do plików przez proste API. Dzięki temu będziesz mógł wyświetlić swoją kronikę w sposób jaki TY chcesz.
-
-Jeśli chodzi o Facebooka to jedynym rozwiązaniem byłoby użycie Instant Articles połączonych z RSS'em na stronce. Nie jest to rozwiązanie idealne ale całkiem niezłe.
-
+docs/README.md
\ No newline at end of file