From 50f64fa495604109c29b147022283fc9a5e04269 Mon Sep 17 00:00:00 2001 From: Marcus Fihlon Date: Fri, 23 May 2025 19:00:27 +0200 Subject: [PATCH] docs: README mit Strukturhinweisen erstellt --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e62fdd3 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Quelltexte zu Artikeln in der Zeitschrift *Java aktuell* + +In diesem Repository findest du die Quelltexte und Konfigurationsbeispiele zu Artikeln, die von mir in der Zeitschrift *Java aktuell* veröffentlicht wurden. Da in einer gedruckten Zeitschrift kein direktes Kopieren von Quelltexten möglich ist (und selbst bei PDF-Versionen oft Formatierungsprobleme auftreten), stelle ich hier alle relevanten Dateien in strukturierter Form zur Verfügung. + +## Struktur + +Für jeden Artikel gibt es ein eigenes Unterverzeichnis. Der Verzeichnisname besteht aus der Ausgabennummer und einem thematischen Stichwort, zum Beispiel: `2503-forgejo` + +In jedem dieser Verzeichnisse befinden sich: + +- die im Artikel erwähnten Codebeispiele, +- ggf. ergänzende Konfigurationsdateien oder Shell-Skripte, +- manchmal auch zusätzliche Hinweise oder weiterführende Links in einer `README.md`. + +## Verwendung + +Die hier veröffentlichten Inhalte sind dazu gedacht, das Nachvollziehen der Artikelinhalte zu erleichtern und beim Ausprobieren zu unterstützen. Alle Beispiele sind so strukturiert, dass sie ohne grösseren Aufwand ausprobiert oder in eigene Projekte integriert werden können. + +## Feedback + +Fragen, Anregungen oder Hinweise zu den Artikeln oder dem bereitgestellten Code sind willkommen. Idealerweise direkt an mich über [Matrix](https://matrix.to/#/@mcpringle:matrix.org), [Threema](https://threema.id/M36HU8SN), [Mastodon](https://fosstodon.org/@McPringle), [E-Mail](mailto:marcus@fihlon.swiss) oder alternativ über die Kommunikationskanäle der Zeitschrift [Java aktuell](https://www.ijug.eu/de/java-aktuell/zeitschrift/). + +--- + +> Dieses Repository wird fortlaufend gepflegt und um neue Artikel ergänzt.