From 71243c11c450cab06a33ba370d12a3b3f3ef0a5c Mon Sep 17 00:00:00 2001
From: Marianne Chevrot <blackmoor+git@devys.org>
Date: Mon, 27 Apr 2020 19:22:26 +0200
Subject: Add level infos and level 4.6

---
 readme.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'readme.rst')

diff --git a/readme.rst b/readme.rst
index 3b93ae4..52d367a 100644
--- a/readme.rst
+++ b/readme.rst
@@ -6,3 +6,19 @@ kana in this form:
 - rock
 - void
 - empty
+
+
+Level file are store in `kana_quest_level`. Format is yaml.
+Example file `level_XX.XX.yaml`::
+    # kana quest grid level XX.XX
+    size: [3, 2]
+    max_actions: 1
+    target_score: 3
+    grid: [
+      [void, null], [myst, nu  ], [void, null],
+      [froz, ne  ], [empt, null], [rock, 'no'],
+    ]
+
+**WARNING** in level file definition:
+The kana 'no' need to be protected else the program convert it into False...
+
-- 
cgit v1.2.3