summaryrefslogtreecommitdiffabout
diff options
context:
space:
mode:
authorArmaël Guéneau <armael.gueneau@ens-lyon.fr>2017-07-11 18:48:33 (CEST)
committer Armaël Guéneau <armael.gueneau@ens-lyon.fr>2017-07-11 18:48:33 (CEST)
commit992f948f27ade8c06bb98f5d8129aa8dc9c60a4b (patch)
tree28dbe7910db74578e43a3b96f99b1e909046418c
parent58e231ea6b8edc786c3d001a213a10f45acd6337 (diff)
downloaddict-992f948f27ade8c06bb98f5d8129aa8dc9c60a4b.tar.gz
dict-992f948f27ade8c06bb98f5d8129aa8dc9c60a4b.tar.bz2
Improve READMEHEADmaster
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1b8c212..6a24102 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,24 @@
### dict: a simple dictionary webapp
+#### Demo
+
+Featuring a toki pona dictionary: [http://dev.isomorphis.me/tokipona/](http://dev.isomorphis.me/tokipona/)
+
+#### Build
+
+Install dependencies:
```
opam install batteries js_of_ocaml-ppx js_of_ocaml-tyxml js_of_ocaml-lwt
+```
+
+Then:
+```
make deploy
firefox public/index.html
```
+
+#### Changing the dictionary
+
+- Add a `.txt` file in `init/`, with a translation per line, translations being
+ separated by `::`. See `init/dict.txt` for a simple example.
+- Adapt `let lang = ...` and `let dict_name = ...` at the beginning of `dict.ml`.