Skip to content
HTML CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
site
.gitignore
README.md
mkdocs.yml

README.md

learn2proGrAME-Tutorial

Tutorial/Tutorial

How to Contribute/Wie mitwirken?

Installation

The tutorial is written using mkdocs with the material theme. Please refer to the project webpages for install instructions.

Das Tutorial wird mit mkdocs unter Verwendung der material theme geschrieben. Installationsanweisungen finden sich auf den jeweiligen Projektwebseiten.

Requirements/Anforderungen: Python >2.7

If you have pip installed, you can

Falls pip bereits installiert ist, kann man:

pip install mkdocs

pip install mkdocs-material

Workflow

Through mkdocs serve tutorial-documentation can be previewed locally.

mkdocs serve ermöglicht eine lokale Vorschau der Inhalte der Tutorial-Dokumentation.

Naming conventions and Folderstructure/Namenskonvention und Ordnerstruktur

Markdown Files/Dateien

......

Images/Bilder

  • are in the img-Folder of a chapter/befinden sich im img-Ordner des dazugehörigen Kapitels
  • start with a chapter number/beginnen mit der Kapitelnummer
  • no space/keine Leerzeichen
  • informative naming/aussagekräftig

Writing Style Guidelines/Schreib-Stil Leitlinien1

  • rather simple than complicated (short sentences, frequently used words, terms are defined, demonstrative)/eher einfach als kompliziert (kurze Sätze, häufig verwendete Wörter, Fachbegriffe werden erklärt, anschaulich)
  • rather ordered (in sequence, captions, “common thread”)/eher geordnet (nach der Reihe, Überschriften, “roter Faden”)
  • rather short and concise (essential content, attuned to learning goals)/eher kurz und prägnant (Kerninhalte, ausgerichtet auf Lernziele)
  • additional incentives (interesting, varied, relatable)/Zusätzliche Anregungen (interessant, abwechslungsreich, man kann sich damit in Beziehung setzen)

Chapter Structure / Kapitelstruktur

  • Caption/Überschrift
  • Learning goals/Lernziele
  • Main Content/Hauptinhalte
    • including exercises, work assignments, hints, special notices, references or quotes/beinhaltet Übungen, Arbeitsaufträge, Tipps, besondere Hinweise (Achtung), Referenzen oder Zitate
  • Further resources/Weiterführende Resourcen
    • including links to other tutorials, videos, books/beinhaltet Links zu anderen Tutorials, Videos oder Büchern

Thanks to all supporters and contributors! Danke an alle UnterstützerInnen und Mitwirkenden!

1: Tausch & Tausch (1998). Educational psychology (orig.: Erziehungspsychologie). Hogrefe, Göttingen. p. 266-277.

You can’t perform that action at this time.