Adds README for PlantUML devcontainer template
Introduces a README file detailing the setup and features of a PlantUML devcontainer template. Provides instructions for usage, technical details, folder structure, and an example diagram. Enhances documentation for easier onboarding and reproducibility.
This commit is contained in:
57
README.md
Normal file
57
README.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# PlantUML Devcontainer Template
|
||||
|
||||
Dieses Template stellt eine vollständig vorbereitete Entwicklungsumgebung für die Arbeit mit PlantUML bereit – inklusive Server-Modus direkt im Container. Es eignet sich sowohl für lokale Entwicklung mit Visual Studio Code als auch für reproduzierbare Team- oder CI-Setups.
|
||||
|
||||
## ✨ Features
|
||||
|
||||
- 🐳 **Devcontainer-kompatibel** (VSCode Remote Containers / Codespaces)
|
||||
- ☕ Java + Graphviz vorinstalliert
|
||||
- 🌐 PlantUML-Server wird beim Start automatisch aktiviert (`localhost:8080`)
|
||||
- 🧠 Kein externer Docker nötig, keine separate Java-Installation
|
||||
- 🔁 Wiederverwendbar, reproduzierbar, offlinefähig
|
||||
|
||||
## 🚀 Loslegen
|
||||
|
||||
1. Repository clonen:
|
||||
```bash
|
||||
git clone https://github.com/deinuser/plantuml-devcontainer-template.git
|
||||
cd plantuml-devcontainer-template
|
||||
```
|
||||
|
||||
2. In VSCode öffnen:
|
||||
```bash
|
||||
code .
|
||||
```
|
||||
|
||||
3. Devcontainer starten (automatisch über VSCode gefragt oder über Befehls-Palette: `Dev Containers: Reopen in Container`)
|
||||
|
||||
4. `.puml`-Datei erstellen oder öffnen und `Alt+D` drücken für die Vorschau.
|
||||
|
||||
## ⚙️ Technische Details
|
||||
|
||||
- Der PlantUML-HTTP-Server wird beim Öffnen eines Terminals automatisch gestartet, **wenn er noch nicht läuft**.
|
||||
- Das geschieht über ein kleines Shellskript (`~/.start-plantuml.sh`), das in `.bashrc` eingebunden ist.
|
||||
- Serveradresse für die VSCode-Erweiterung ist vordefiniert: `http://localhost:8080`
|
||||
|
||||
## 📂 Struktur
|
||||
|
||||
```
|
||||
.devcontainer/
|
||||
├── devcontainer.json
|
||||
├── Dockerfile
|
||||
README.md
|
||||
uml/
|
||||
└── beispiel.puml
|
||||
```
|
||||
|
||||
## 🧪 Beispiel
|
||||
|
||||
```plantuml
|
||||
@startuml
|
||||
Alice -> Bob: Hello
|
||||
@enduml
|
||||
```
|
||||
|
||||
## 📄 Lizenz
|
||||
|
||||
MIT – Verwenden, anpassen, verbessern.
|
Reference in New Issue
Block a user