- Forkold a projektet.
- Dolgozz ki egy tételt, vagy egészíts ki / javíts egy meglévőt.
- Csinálj egy pull request-et.
-
Annak érdekében, hogy a dokumentumot közösen tudjuk szerkeszteni, a kód átlátható legyen, majd azt tetszőleges eszközről meg tudjuk tekinteni és tetszőleges formátumba tudjunk exportálni, a MarkDown szintaxist választottuk, mivel egyszerű, és nem igényel különösebb tanulást.
-
Minden tétel kidolgozás elejére kerüljön egy tartalomjegyzék!
-
Ha van rá lehetőség a tétel végén a forrásokat, további irodalmat is tüntessük fel!
- A Markdown szintaxis sajnos nem minden esetben elegendő, így képletek írására TeX-szintaxist használunk.
A képleteket kétféleképpen írhatjuk, egyrészt az inline képleteket $ (sima dollár) jelek között, illetve $$ (dupla dollár) jelek között
a külön paragrafusba megjelenőket. A képleteket tartalmazó dokumentumokból
pandoc-kal PDF-et tudunk generálni. - Az indentáláshoz
soft tabokathasználunk (egy tabulátort 4 szóköz karakter reprezentál). - A szintaktukus elemek ` karakterek közé kerüljenek (pl.:
this)! - A sorok szélessége 120 karakter legyen, sorvégi whitespace-k ne maradjanak!
A tételeket az alábbi helyekre tedd: ./<blokkazonosító>/<tételsorszám>.md, pl: ./s02/2.md
Egy referencia kidolgozás nemsokára elkészül, az a segítségedre lesz a formázással kapcsolatban.