update

webis-de · Jun 19, 2024 · d561dc6 · d561dc6
1 parent b826568
commit d561dc6
Show file tree

Hide file tree

Showing 29 changed files with 72 additions and 61 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,19 @@
+# GenIRSim
+
+Quickstart:
 ```
+npm install
 npm exec simulate-search configurations/default-configuration.json > eval.json
 ```
 
 To run web server: 
 ```
 npm install ws
+npm exec simulation-server
+```
+
+
+## Maintenance
+```
+npm run doc
 ```
diff --git a/bin/simulation-server.js b/bin/simulation-server.js
@@ -68,5 +68,7 @@ server.on("upgrade", (request, socket, head) => {
     webSocketServer.emit("connection", websocket, request);
   });
 });
+
+console.log("Starting server on port " + PORT);
 server.listen(PORT);
 
diff --git a/doc/api/assets/anchor.js → docs/api/assets/anchor.js b/doc/api/assets/anchor.js → docs/api/assets/anchor.js
diff --git a/doc/api/assets/bass-addons.css → docs/api/assets/bass-addons.css b/doc/api/assets/bass-addons.css → docs/api/assets/bass-addons.css
diff --git a/doc/api/assets/bass.css → docs/api/assets/bass.css b/doc/api/assets/bass.css → docs/api/assets/bass.css
diff --git a/...i/assets/fonts/EOT/SourceCodePro-Bold.eot → ...i/assets/fonts/EOT/SourceCodePro-Bold.eot b/...i/assets/fonts/EOT/SourceCodePro-Bold.eot → ...i/assets/fonts/EOT/SourceCodePro-Bold.eot
diff --git a/...ssets/fonts/EOT/SourceCodePro-Regular.eot → ...ssets/fonts/EOT/SourceCodePro-Regular.eot b/...ssets/fonts/EOT/SourceCodePro-Regular.eot → ...ssets/fonts/EOT/SourceCodePro-Regular.eot
diff --git a/doc/api/assets/fonts/LICENSE.txt → docs/api/assets/fonts/LICENSE.txt b/doc/api/assets/fonts/LICENSE.txt → docs/api/assets/fonts/LICENSE.txt
diff --git a/...i/assets/fonts/OTF/SourceCodePro-Bold.otf → ...i/assets/fonts/OTF/SourceCodePro-Bold.otf b/...i/assets/fonts/OTF/SourceCodePro-Bold.otf → ...i/assets/fonts/OTF/SourceCodePro-Bold.otf
diff --git a/...ssets/fonts/OTF/SourceCodePro-Regular.otf → ...ssets/fonts/OTF/SourceCodePro-Regular.otf b/...ssets/fonts/OTF/SourceCodePro-Regular.otf → ...ssets/fonts/OTF/SourceCodePro-Regular.otf
diff --git a/...i/assets/fonts/TTF/SourceCodePro-Bold.ttf → ...i/assets/fonts/TTF/SourceCodePro-Bold.ttf b/...i/assets/fonts/TTF/SourceCodePro-Bold.ttf → ...i/assets/fonts/TTF/SourceCodePro-Bold.ttf
diff --git a/...ssets/fonts/TTF/SourceCodePro-Regular.ttf → ...ssets/fonts/TTF/SourceCodePro-Regular.ttf b/...ssets/fonts/TTF/SourceCodePro-Regular.ttf → ...ssets/fonts/TTF/SourceCodePro-Regular.ttf
diff --git a/...onts/WOFF/OTF/SourceCodePro-Bold.otf.woff → ...onts/WOFF/OTF/SourceCodePro-Bold.otf.woff b/...onts/WOFF/OTF/SourceCodePro-Bold.otf.woff → ...onts/WOFF/OTF/SourceCodePro-Bold.otf.woff
diff --git a/...s/WOFF/OTF/SourceCodePro-Regular.otf.woff → ...s/WOFF/OTF/SourceCodePro-Regular.otf.woff b/...s/WOFF/OTF/SourceCodePro-Regular.otf.woff → ...s/WOFF/OTF/SourceCodePro-Regular.otf.woff
diff --git a/...onts/WOFF/TTF/SourceCodePro-Bold.ttf.woff → ...onts/WOFF/TTF/SourceCodePro-Bold.ttf.woff b/...onts/WOFF/TTF/SourceCodePro-Bold.ttf.woff → ...onts/WOFF/TTF/SourceCodePro-Bold.ttf.woff
diff --git a/...s/WOFF/TTF/SourceCodePro-Regular.ttf.woff → ...s/WOFF/TTF/SourceCodePro-Regular.ttf.woff b/...s/WOFF/TTF/SourceCodePro-Regular.ttf.woff → ...s/WOFF/TTF/SourceCodePro-Regular.ttf.woff
diff --git a/...ts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2 → ...ts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2 b/...ts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2 → ...ts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2
diff --git a/...WOFF2/OTF/SourceCodePro-Regular.otf.woff2 → ...WOFF2/OTF/SourceCodePro-Regular.otf.woff2 b/...WOFF2/OTF/SourceCodePro-Regular.otf.woff2 → ...WOFF2/OTF/SourceCodePro-Regular.otf.woff2
diff --git a/...ts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2 → ...ts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2 b/...ts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2 → ...ts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2
diff --git a/...WOFF2/TTF/SourceCodePro-Regular.ttf.woff2 → ...WOFF2/TTF/SourceCodePro-Regular.ttf.woff2 b/...WOFF2/TTF/SourceCodePro-Regular.ttf.woff2 → ...WOFF2/TTF/SourceCodePro-Regular.ttf.woff2
diff --git a/doc/api/assets/fonts/source-code-pro.css → docs/api/assets/fonts/source-code-pro.css b/doc/api/assets/fonts/source-code-pro.css → docs/api/assets/fonts/source-code-pro.css
diff --git a/doc/api/assets/github.css → docs/api/assets/github.css b/doc/api/assets/github.css → docs/api/assets/github.css
diff --git a/doc/api/assets/site.js → docs/api/assets/site.js b/doc/api/assets/site.js → docs/api/assets/site.js
diff --git a/doc/api/assets/split.css → docs/api/assets/split.css b/doc/api/assets/split.css → docs/api/assets/split.css
diff --git a/doc/api/assets/split.js → docs/api/assets/split.js b/doc/api/assets/split.js → docs/api/assets/split.js
diff --git a/doc/api/assets/style.css → docs/api/assets/style.css b/doc/api/assets/style.css → docs/api/assets/style.css
diff --git a/doc/api/config.yml → docs/api/config.yml b/doc/api/config.yml → docs/api/config.yml
@@ -1,7 +1,7 @@
 toc:
   - name: GenIRSim
     description: |
-      TODO [[code](https://github.com/webis-de/scriptor)] [[package](https://www.npmjs.com/package/@webis-de/scriptor)]
+      TODO [[code](https://github.com/webis-de/GenIRSim)] [[package](https://www.npmjs.com/package/@webis-de/scriptor)]
   - run
   - simulate
   - evaluate

diff --git a/doc/api/index.html → docs/api/index.html b/doc/api/index.html → docs/api/index.html
diff --git a/package.json b/package.json
@@ -12,15 +12,13 @@
     "simulation-server": "bin/simulation-server.js"
   },
   "scripts": {
-    "doc": "documentation build -f html -o doc/api/ --github --config doc/api/config.yml"
+    "doc": "documentation build -f html -o docs/api/ --github --config docs/api/config.yml"
   },
   "dependencies": {
-    "jsonrepair": "^3.8.0"
+    "jsonrepair": "^3.8.0",
+    "ws": "^8.17.1"
   },
   "type": "module",
   "author": "Johannes Kiesel <[email protected]>",
-  "license": "MIT",
-  "dependencies": {
-    "ws": "^8.17.1"
-  }
+  "license": "MIT"
 }