VRH / devprocdoc

Commit 84318e829e22c551f279fcb0e396d4ddb6f2adb0

Authored by Görcsös Zoltán
1 parent 157cb697

Readme szerkesztése

Showing 1 changed file with 15 additions and 10 deletions   Show diff stats
Inline Side-by-side
README.md
  Show/Hide comments   View file @84318e8
1   -![][headerpic]
  1 +![][#headerpic]
2 2  
3 3 # devprocdoc = Developer Process Documentation
4   -> A repository alatt van vezetve a Vrh fejelsztési folymatainak dokumentációja.
  4 +> A repository alatt vezetjük a Vrh fejlesztési folyamatainak dokumentációját.
5 5  
6   -## Szabályok
  6 +## Szabályok:
7 7 * A dokumentáció **kizárólag** markdown alapú!
8 8 * A dokumentáció organizációja **könyvtárakra** törve történik
9 9 * A repository az MD fájlokon túl képeket tartalmazhat, melyek a markdown fájlokban hivatkozásra kerülnek.
10   -* A diskurzus a dokumentációről **kizárólag** itt történik!
11   - * Használd a, beépített **Issue tracckert**
12   - * és a **commitok** megjegyzés hozzáfüzési lehetőségét
13   -* A project open, hogy dokumentációra a közvetlen gitlab.vonalkod.hu alatti linkeket egyszerűen meg lehessen osztani **bárkivel**.
14   -* Mivel a fő megjelenítőnk a gitlab
  10 +* A diskurzus a dokumentáció tartalmáról **kizárólag** itt történik!
  11 + * Használd a beépített **Issue tracckert**
  12 + * és a **commitok** megjegyzés hozzáfűzési lehetőségét
  13 +* A project open, hogy a dokumentáció a közvetlen gitlab.vonalkod.hu alatti linkkel egyszerűen meg lehessen osztani **bárkivel**.
  14 +* 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]
  15 +* Jó offline MD szerkesztő: [Markdown Monster][#markdownmonster]
  16 +* Vagy egyszerűen használd a gitlab beépített markdown editorát...
15 17  
16   -[headerpic]: <http://gitlab.vonalkod.hu:443/uploads/project/avatar/193/rules.png>
17   -[gitlabmddoc]: <https://gitlab.com/help/user/markdown>
18 18 \ No newline at end of file
  19 +> # **Follow the rules!**
  20 +
  21 +[#headerpic]: <http://gitlab.vonalkod.hu:443/uploads/project/avatar/193/rules.png>
  22 +[#gitlabmddoc]: <https://gitlab.com/help/user/markdown>
  23 +[#markdownmonster]: <https://markdownmonster.west-wind.com/download.aspx>
... ...