Install jsdoc and jsdoc-to-markdown

2023-08-03 16:51:42 +01:00 · 2023-08-03 16:51:42 +01:00 · 3597ad1b01
parent 6ebebe294e
commit 3597ad1b01
3 changed files with 1051 additions and 10 deletions
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@ -2,8 +2,13 @@
  "name": "paper-computer",
  "scripts": {
    "rundisplay": "node assemble-and-run.js run",
-    "rundebug":   "node assemble-and-run.js debug",
+    "rundebug": "node assemble-and-run.js debug",
    "asm": "node assemble.js run",
-    "asmdebug":  "node assemble.js debug"
+    "asmdebug": "node assemble.js debug",
+    "jsdoc": "./node_modules/.bin/jsdoc"
+  },
+  "devDependencies": {
+    "jsdoc": "^4.0.2",
+    "jsdoc-to-markdown": "^8.0.0"
  }
-}
+}
--- a/readme.md
+++ b/readme.md
@ -2,6 +2,10 @@

 ## To do

+### Misc
+
+- [ ] Play with JSDoc
+
 ### Testing/using

 - [ ] Write some more complex test programs