README draft

README.md

@@ -0,0 +1,49 @@
+# Bomberscript
+
+This is a pure JavaScript implementation of a bomberman-like game. There's an [online instance].
+
+## Build
+
+This is mainly to get some CSS files and images, you'll only need the `wget` command, then:
+
+```sh
+scripts/build.sh
+```
+
+## Test
+
+This is only to type-check the JS files. You need to have the [flow] command available, then:
+
+```sh
+scripts/test.sh
+```
+
+## Run
+
+Do something like this, it should work if you use a *[decent]* operating system:
+
+```sh
+xdg-open src/index.html
+```
+
+## Install
+
+To install it on your own server, assuming you're using Apache, just edit the first lines in the `bomberman.conf` file - you'll need to generate a certificate, which I'm not going to cover here. Then, just edit the `domain` in `scripts/install.sh` and run:
+
+```sh
+scripts/install.sh
+```
+
+## Change Log
+
+See [CHANGELOG].
+
+## License
+
+See [LICENSE].
+
+[CHANGELOG]: ./CHANGELOG.md
+[LICENSE]: ./LICENSE.md
+[online instance]: https://bomberman.zapashcanon.fr
+[flow]: https://flow.org/
+[decent]: https://www.debian.org/