mirror of
https://github.com/jneug/zeichenmaschine.git
synced 2026-04-14 14:43:33 +02:00
MKDocs Dokumentation erweitert
This commit is contained in:
@@ -1,43 +0,0 @@
|
||||
|
||||
<figure markdown>
|
||||
{ width=128 }
|
||||
</figure>
|
||||
|
||||
<h1 class="title">Zeichenmaschine.xyz</h1>
|
||||
<h2 class="subtitle">Eine kleine Java-Bibliothek für grafische Programmierung im
|
||||
Informatikunterricht.</h2>
|
||||
|
||||
## Projektidee
|
||||
|
||||
Die **Zeichenmaschine** ist eine für den Informatikunterricht entwickelte Bibliothek,
|
||||
die unter anderem an [Processing](https://processing.org/) angelehnt ist. Die
|
||||
Bibliothek soll einige der üblichen Anfängerschwierigkeiten mit Java vereinfachen
|
||||
und für Schülerinnen und Schüler im Unterricht nutzbar machen.
|
||||
|
||||
!!! warning
|
||||
|
||||
Das Projekt befindet sich noch in der Entwicklungsphase und auch wenn die
|
||||
aktuelle Version schon funktionsfähig ist und einen Großteil der angestrebten
|
||||
Funktionen enthält, ist noch keine stabile Version 1.0 erreicht. Vor allem
|
||||
am Umfang und konsistenten Design der APIs gilt es noch zu arbeiten und es
|
||||
können sich Änderungen ergeben.
|
||||
|
||||
Feedback und Vorschläge zu diesem Prozess (oder auch eine Beteiligung an der
|
||||
Entwicklung) können sehr gerne über [Github](https://github.com/jneug) oder
|
||||
[Mastodon](https://bildung.social/@ngb) an mich kommuniziert werden.
|
||||
|
||||
(Gleiches gilt für diese Webseite zum Projekt.)
|
||||
|
||||
## Dokumentation
|
||||
* [Schnellstart](quickstart.md)
|
||||
* [Installation](install.md)
|
||||
* {{ javadoc_link() }}
|
||||
|
||||
## Über die Zeichenmaschine
|
||||
|
||||
!!! info
|
||||
|
||||
In der Zeichenmaschine werden bewusst nur englischsprachige Bezeichner für
|
||||
Klassen, Methoden und Variablen verwendet. Ausnahme sind einzelne Klassen,
|
||||
die im Zusammnehang mit dem Namen der Bibliothek stehen, wie die
|
||||
Hauptklasse `Zeichenmaschine`.
|
||||
Reference in New Issue
Block a user