Add initial working version

1 files changed, 26 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..69a4f26
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Getting started
+
+```bash
+nix develop --command bin/watch.sh
+```
+
+# Deck
+
+Cards are created from a plain text `./deck` file:
+
+```
+# This is a comment
+
+- good moorning : bonjour
+- alternative 1 | alternative 2 : choix 1 | choix 2
+```
+
+# TODO
+
+- indications in parenthesis ?
+- Fix crashes on zoom / changing size
+
+## Nice to have
+
+- Add phonetics indication
+- Select deck