„README.md“ ändern

README.md

@@ -1,43 +1,46 @@
-# Module Agency
+# Nextcloud Vue.js Template Placeholder
+Dies ist eine Vorlage, um neue Module für die DA im Rahmen von Nextcloud mit Vue.js zu implementieren.
 
-## Was zu ändern ist
+## Dateien zum ändern
+Folgende Dateien müssen mit dem neuen Modulnamen abgeändert werden.
 
-Änderungen bei einem neuen Modul
+### appinfo
+* info.xml
+    * id, name, summary, namespace, category, navigation (name, route, icon)
+* routes.php
+    * Eventuell hier anpassen, aber das erstmal so lassen
 
-appinfo -> 
+### js
-	info.xml
+* Dieser Ordner sollte leer sein. Hier kommen später durch *make build-js* bzw. für den HotReload *make watch-js* gefüllt.
-	- id, name, summary, namespace, category, navigation (name, route, icon)
-	routes.php
-	- Eventuell hier anpassen, aber das erstmal so lassen
 
-js ->
+### lib -> Controller
-	Dieser Ordner sollte LEER sein
+* PageController.php
+    * namespace (Zeile 4), 
+    * Zeile 25 bei main den neuen Modulnamen davorschreiben
 
-lib -> Controller ->
+### src
-	PageController.php
+* App.vue
-	- namespace (Zeile 4), 
+    * bei Content den app-name ändern, NICHT aber weiter unten bei export default usw.
-	- Zeile 25 bei main den neuen Modulnamen davorschreiben
-src ->
-	App.vue
-	- bei Content den app-name ändern, NICHT aber weiter unten bei export default usw.
 
-README.md
+### README.md
-	Hier einmal als Kommentar den Modulnamen anpassen fürs Git
+* Hier einmal als Kommentar den Modulnamen anpassen fürs Git
-composer.json
-	bei name anpassen auf da/NAMEDESMODULS
-	description anpassen
-package.json
-	name und desc anpassen sowie version und author
 
-Befehl für den Docker und die Bash, um die Befehle beim Docker abzusetzen
+### composer.json
-docker exec -it nextcloud bash  
+* Bei *name* anpassen auf da/NAME_DES_MODULS
+* description anpassen
+* package.json
+    * name und desc anpassen sowie version und author
 
-hier dann ins Verzeichnis, dann:
+## Befehle und Hinweise
-npm install
+Folgender Befehl wird benötigt, um auf dem entsprechenden Docker die Bash zu starten:
+**docker exec -it nextcloud bash**
+
+Im Verzeichnis dann die Dependencies installieren:
+**npm install**
 
 Das dauert dann kurz, weil ja alle node_modules installiert und eingerichtet werden.
 
-dann für HOT REALOAD: make watch-js
+Dann für HOT REALOAD: *make watch-js*
-oder für BUILD: make build-js
+oder für BUILD: *make build-js*
--> Die Skripte sind in der package.json verlinkt
+Die Skripte sind in der package.json verlinkt