From 84318e829e22c551f279fcb0e396d4ddb6f2adb0 Mon Sep 17 00:00:00 2001 From: Görcsös Zoltán Date: Thu, 27 Sep 2018 21:14:15 +0200 Subject: [PATCH] Readme szerkesztése --- README.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1c6be2a..353b140 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,22 @@ -![][headerpic] +![][#headerpic] # devprocdoc = Developer Process Documentation -> A repository alatt van vezetve a Vrh fejelsztési folymatainak dokumentációja. +> A repository alatt vezetjük a Vrh fejlesztési folyamatainak dokumentációját. -## Szabályok +## Szabályok: * A dokumentáció **kizárólag** markdown alapú! * A dokumentáció organizációja **könyvtárakra** törve történik * A repository az MD fájlokon túl képeket tartalmazhat, melyek a markdown fájlokban hivatkozásra kerülnek. -* A diskurzus a dokumentációről **kizárólag** itt történik! - * Használd a, beépített **Issue tracckert** - * és a **commitok** megjegyzés hozzáfüzési lehetőségét -* A project open, hogy dokumentációra a közvetlen gitlab.vonalkod.hu alatti linkeket egyszerűen meg lehessen osztani **bárkivel**. -* Mivel a fő megjelenítőnk a gitlab +* A diskurzus a dokumentáció tartalmáról **kizárólag** itt történik! + * Használd a beépített **Issue tracckert** + * és a **commitok** megjegyzés hozzáfűzési lehetőségét +* A project open, hogy a dokumentáció a közvetlen gitlab.vonalkod.hu alatti linkkel egyszerűen meg lehessen osztani **bárkivel**. +* Mivel a fő megjelenítőnk a gitlab, ezért *GitLab Flavored Markdown*-t használunk. A cél, hogy a gitlabon jól nézzen ki. GFM-ről dokumentáció [itt][#gitlabmddoc] +* Jó offline MD szerkesztő: [Markdown Monster][#markdownmonster] +* Vagy egyszerűen használd a gitlab beépített markdown editorát... -[headerpic]: -[gitlabmddoc]: \ No newline at end of file +> # **Follow the rules!** + +[#headerpic]: +[#gitlabmddoc]: +[#markdownmonster]: -- libgit2 0.21.2