diff --git a/README.md b/README.md index 880b888..5a8799f 100644 --- 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 index 5caf75e..892f71b 100755 --- 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 b/docs/api/assets/anchor.js similarity index 100% rename from doc/api/assets/anchor.js rename to docs/api/assets/anchor.js diff --git a/doc/api/assets/bass-addons.css b/docs/api/assets/bass-addons.css similarity index 100% rename from doc/api/assets/bass-addons.css rename to docs/api/assets/bass-addons.css diff --git a/doc/api/assets/bass.css b/docs/api/assets/bass.css similarity index 100% rename from doc/api/assets/bass.css rename to docs/api/assets/bass.css diff --git a/doc/api/assets/fonts/EOT/SourceCodePro-Bold.eot b/docs/api/assets/fonts/EOT/SourceCodePro-Bold.eot similarity index 100% rename from doc/api/assets/fonts/EOT/SourceCodePro-Bold.eot rename to docs/api/assets/fonts/EOT/SourceCodePro-Bold.eot diff --git a/doc/api/assets/fonts/EOT/SourceCodePro-Regular.eot b/docs/api/assets/fonts/EOT/SourceCodePro-Regular.eot similarity index 100% rename from doc/api/assets/fonts/EOT/SourceCodePro-Regular.eot rename to docs/api/assets/fonts/EOT/SourceCodePro-Regular.eot diff --git a/doc/api/assets/fonts/LICENSE.txt b/docs/api/assets/fonts/LICENSE.txt similarity index 100% rename from doc/api/assets/fonts/LICENSE.txt rename to docs/api/assets/fonts/LICENSE.txt diff --git a/doc/api/assets/fonts/OTF/SourceCodePro-Bold.otf b/docs/api/assets/fonts/OTF/SourceCodePro-Bold.otf similarity index 100% rename from doc/api/assets/fonts/OTF/SourceCodePro-Bold.otf rename to docs/api/assets/fonts/OTF/SourceCodePro-Bold.otf diff --git a/doc/api/assets/fonts/OTF/SourceCodePro-Regular.otf b/docs/api/assets/fonts/OTF/SourceCodePro-Regular.otf similarity index 100% rename from doc/api/assets/fonts/OTF/SourceCodePro-Regular.otf rename to docs/api/assets/fonts/OTF/SourceCodePro-Regular.otf diff --git a/doc/api/assets/fonts/TTF/SourceCodePro-Bold.ttf b/docs/api/assets/fonts/TTF/SourceCodePro-Bold.ttf similarity index 100% rename from doc/api/assets/fonts/TTF/SourceCodePro-Bold.ttf rename to docs/api/assets/fonts/TTF/SourceCodePro-Bold.ttf diff --git a/doc/api/assets/fonts/TTF/SourceCodePro-Regular.ttf b/docs/api/assets/fonts/TTF/SourceCodePro-Regular.ttf similarity index 100% rename from doc/api/assets/fonts/TTF/SourceCodePro-Regular.ttf rename to docs/api/assets/fonts/TTF/SourceCodePro-Regular.ttf diff --git a/doc/api/assets/fonts/WOFF/OTF/SourceCodePro-Bold.otf.woff b/docs/api/assets/fonts/WOFF/OTF/SourceCodePro-Bold.otf.woff similarity index 100% rename from doc/api/assets/fonts/WOFF/OTF/SourceCodePro-Bold.otf.woff rename to docs/api/assets/fonts/WOFF/OTF/SourceCodePro-Bold.otf.woff diff --git a/doc/api/assets/fonts/WOFF/OTF/SourceCodePro-Regular.otf.woff b/docs/api/assets/fonts/WOFF/OTF/SourceCodePro-Regular.otf.woff similarity index 100% rename from doc/api/assets/fonts/WOFF/OTF/SourceCodePro-Regular.otf.woff rename to docs/api/assets/fonts/WOFF/OTF/SourceCodePro-Regular.otf.woff diff --git a/doc/api/assets/fonts/WOFF/TTF/SourceCodePro-Bold.ttf.woff b/docs/api/assets/fonts/WOFF/TTF/SourceCodePro-Bold.ttf.woff similarity index 100% rename from doc/api/assets/fonts/WOFF/TTF/SourceCodePro-Bold.ttf.woff rename to docs/api/assets/fonts/WOFF/TTF/SourceCodePro-Bold.ttf.woff diff --git a/doc/api/assets/fonts/WOFF/TTF/SourceCodePro-Regular.ttf.woff b/docs/api/assets/fonts/WOFF/TTF/SourceCodePro-Regular.ttf.woff similarity index 100% rename from doc/api/assets/fonts/WOFF/TTF/SourceCodePro-Regular.ttf.woff rename to docs/api/assets/fonts/WOFF/TTF/SourceCodePro-Regular.ttf.woff diff --git a/doc/api/assets/fonts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2 b/docs/api/assets/fonts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2 similarity index 100% rename from doc/api/assets/fonts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2 rename to docs/api/assets/fonts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2 diff --git a/doc/api/assets/fonts/WOFF2/OTF/SourceCodePro-Regular.otf.woff2 b/docs/api/assets/fonts/WOFF2/OTF/SourceCodePro-Regular.otf.woff2 similarity index 100% rename from doc/api/assets/fonts/WOFF2/OTF/SourceCodePro-Regular.otf.woff2 rename to docs/api/assets/fonts/WOFF2/OTF/SourceCodePro-Regular.otf.woff2 diff --git a/doc/api/assets/fonts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2 b/docs/api/assets/fonts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2 similarity index 100% rename from doc/api/assets/fonts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2 rename to docs/api/assets/fonts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2 diff --git a/doc/api/assets/fonts/WOFF2/TTF/SourceCodePro-Regular.ttf.woff2 b/docs/api/assets/fonts/WOFF2/TTF/SourceCodePro-Regular.ttf.woff2 similarity index 100% rename from doc/api/assets/fonts/WOFF2/TTF/SourceCodePro-Regular.ttf.woff2 rename to docs/api/assets/fonts/WOFF2/TTF/SourceCodePro-Regular.ttf.woff2 diff --git a/doc/api/assets/fonts/source-code-pro.css b/docs/api/assets/fonts/source-code-pro.css similarity index 100% rename from doc/api/assets/fonts/source-code-pro.css rename to docs/api/assets/fonts/source-code-pro.css diff --git a/doc/api/assets/github.css b/docs/api/assets/github.css similarity index 100% rename from doc/api/assets/github.css rename to docs/api/assets/github.css diff --git a/doc/api/assets/site.js b/docs/api/assets/site.js similarity index 100% rename from doc/api/assets/site.js rename to docs/api/assets/site.js diff --git a/doc/api/assets/split.css b/docs/api/assets/split.css similarity index 100% rename from doc/api/assets/split.css rename to docs/api/assets/split.css diff --git a/doc/api/assets/split.js b/docs/api/assets/split.js similarity index 100% rename from doc/api/assets/split.js rename to docs/api/assets/split.js diff --git a/doc/api/assets/style.css b/docs/api/assets/style.css similarity index 100% rename from doc/api/assets/style.css rename to docs/api/assets/style.css diff --git a/doc/api/config.yml b/docs/api/config.yml similarity index 89% rename from doc/api/config.yml rename to docs/api/config.yml index 7b33675..40c7ca9 100644 --- a/doc/api/config.yml +++ b/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 b/docs/api/index.html similarity index 95% rename from doc/api/index.html rename to docs/api/index.html index e207d1d..7806938 100644 --- a/doc/api/index.html +++ b/docs/api/index.html @@ -646,7 +646,7 @@