From 560ff79b67466fd381e817bae4bd2b80a1c293c8 Mon Sep 17 00:00:00 2001
From: jsteuer <jan.steuer.htw@gmail.com>
Date: Mon, 30 Sep 2019 07:27:10 +0200
Subject: [PATCH] docs
---
README.md | 22 ++++++++++++++++------
1 files changed, 16 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 5b5fef7..ecec13f 100644
--- a/README.md
+++ b/README.md
@@ -22,15 +22,19 @@
gestartet wurde, kann die API verwendet werden! (Hinweis: durch nachbilden der API kann
eine Nutzung ohne IDE ermöglicht werden, siehe `enableOfflineUsageIfNecessary`)
-## Beispiele
+### 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.
+### Hilfunktionen für Werkzeug-Entwickler
+Dieses Paket beinhaltet zusätzlich Hilfsfunktionen für Werkzeug-Entwickler. Beispielsweise kann
+ein Werkzeug ohne IDE-Anbindung genutzt werden, indem die API nachgebildet wird - aktuell auf
+Basis des LocalStorage des Browsers.
+
+ import { enableOfflineUsageIfNecessary } from "@mathcoach/ide-api";
+ let offline: boolean = enableOfflineUsageIfNecessary();
-
-#### Kleinere Werkzeuge
+### Kleinere Werkzeuge
Für kleiner Werkzeuge bietet es sich an im WWW-Verzeichnis zu entwickeln (z.B.
`myTool/tool.html` und `myTool/tool.js`). Die MathCoach-IDE stellt Autovervollständigung beim
Editieren der `tool.js`-Datei zur Verfügung. Da es sich um eine JavaScript-Datei handelt,
@@ -39,7 +43,7 @@
-#### Größere Werkzeuge
+### Größere Werkzeuge
Für größere Werkzeuge sollte ein Build-System wie [webpack](https://webpack.js.org/)
oder [PARCEL](https://parceljs.org/) in Kombination mit
[TypeScript](https://www.typescriptlang.org/) verwendet werden. Das Werkzeug muss nach dem
@@ -59,6 +63,12 @@
...
}
+Bei Verwendung einer Entwicklungsumgebung wie Visual Studio Code kann die Typdefinition der
+API auch für JavaScript eingebunden werden. Hierfür ist ggf. ein spezielles Kommentar am Anfang
+der Datei notwendig (Pfad falls nötig anpassen):
+
+ /// <reference path="../node_modules/@mathcoach/ide-api/mathcoach-api.d.ts"/>
+
Wie man der Git-Repo URL ansieht, werden Git-Tags verwendet um eine
Versionierung [(Semantic Versioning)](https://semver.org/lang/de/)
der API zu erreichen. Lässt man die Versionierung weg, wird die
--
Gitblit v1.10.0-SNAPSHOT