From 9f94611a42d41cf94cdccb00b5d2eec0d5d02970 Mon Sep 17 00:00:00 2001
From: Joris
Date: Sun, 14 Nov 2021 23:25:55 +0100
Subject: Add initial working version

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

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
-- 
cgit v1.2.3