From 19e29af10d114ffab5cf1535ae1256ec2b161015 Mon Sep 17 00:00:00 2001
From: jsteuer <jan.steuer.htw@gmail.com>
Date: Mon, 30 Sep 2019 07:18:39 +0200
Subject: [PATCH] docs
---
README.md | 16 ++++++++++++++--
1 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index e3b5deb..5b5fef7 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,8 @@
# MathCoach IDE API
-In diesem Paket ist die öffentliche Schnittstelle zur MathCoach Entwicklungsumgebung (IDE)
+In diesem Paket ([Das Gitblit Repository findet sich hier](https://newton.htwsaar.de/gitblit/summary/mathcoach!mathcoach-ide-api.git))
+ist die öffentliche Schnittstelle zur MathCoach Entwicklungsumgebung (IDE)
definiert. Mithilfe dieser Schnittstelle können externe Werkzeuge (z.B. Editoren) erstellt werden.
Für den Anwender stehen diese Werkzeuge dann komfortabel - in die IDE integriert - zur Verfügung.
@@ -18,7 +19,15 @@
- Von nun an steht die hier definierte API durch die globale Variable `MC` zur Verfügung.
- **Hinweis**: Erst, wenn das Werkzeug in die IDE integriert und aus dieser heraus
- gestartet wurde, kann die API verwendet werden!
+ gestartet wurde, kann die API verwendet werden! (Hinweis: durch nachbilden der API kann
+ eine Nutzung ohne IDE ermöglicht werden, siehe `enableOfflineUsageIfNecessary`)
+
+## Beispiele
+Im Verzeichnis `./examples/` finden sich Beispiele für externe Werkzeuge.
+
+## Hilfunktionen für Werkzeug-Entwickler
+Dieses Paket beinhaltet zusätzlich Hilfsfunktionen für Werkzeug-Entwickler.
+
#### Kleinere Werkzeuge
@@ -120,6 +129,9 @@
├── examples // Beispiele
│ ├── ...
│ └── ...
+ ├── src // Hilfsfunktionen für Werkzeugentwickler
+ │ ├── index.ts // Einstiegspunkt
+ │ └── ...
├── mathcoach-api.d.ts // Definition der API
├── package.json
├── package-lock.json
--
Gitblit v1.10.0-SNAPSHOT