Diese Datei (README.md) beschreibt das java-tutorial Projekt, dass über URL https://github.com/msg-azubi/java-tutorial auf der Plattform GitHub allgemein zugänglich ist.
Die Plattform GitHub ist eine Online Plattform für die Veröffentlichung von Git-Repositories.
Auf der Plattform ist es üblich, dass jedes Repository im Wurzelverzeichnis (engl. root directory)
des Projekts eine README.md
hat.
Diese DateiREADME.md
hat eine Dateiendung (.md
). Damit erkennt die Plattform, dass der Inhalt
der Datei ASCII-Code und Texte mittels der MarkDown Syntax formatierbar ist.
GitHub nutzt diese Information, um den Inhalt formatiert darzustellen.
Die GitHub
zeigt unter https://github.com/msg-azubi/java-tutorial eine formatierte Ausgabe der README.md
Datei.
Die unformatierte Ausgabe der README.md
Datei zeigt GitHub über den Link
https://raw.githubusercontent.com/msg-azubi/java-tutorial/master/README.md.
Information zu MarkDown bieten folgende Seiten:
- Mastering MarkDown veröffentlicht auf guides.github.com. (englisch)
- markdown.de/ (deutsch)
- Formatieren von Text mit Markdown veröffentlicht auf support.zendesk.com
-
Das Tutorial gliedert sich in Lerneinheiten (engl units).
Dementsprechend gibt es einen Ordner
units
, der alle Lerneinheiten als Unterordner enthält. Unter IntelliJ gilt ist der Ordnerunits
in der Project Structure als ein Module integriert.IntelliJ Module haben allgemein einen Unterordner
src
, der vor allem den Code zum Kompilieren enthält, so ist es auch hier.-
Jede Lernunit,
unit_XY
, enthält eine Datei `Lernziele.adoc, die über die Lernziele der Unit informDas ist eine Datei im AsciiDoc-Format, diese kann wird über das IntelliJ-Plugin AsciiDoc formatiert angesehen werden.
-
Der Code zu den Lernunits ist im Ordner
units/src
für jede Unit abgelegt.unit_xy/excercise_z/code
Für IntelliJ ist der Ordner
units/src
die Source Root des Modulesunits
. (siehe IntelliJ Help: Folder Categories )
-
-
Git als VCS installieren.
-
IntelliJ als IDE installieren.
a. das IntelliJ-Plugin für AsciiDoc installieren
Das sind die wesentlichen Voraussetzungen.