(#427) Fix svg2rects failure on newlines in labels

[nothing.git] / README.md

diff --git a/README.md b/README.md
index 768700862bf20bddfd71182c3e7dc57678d0e1d6..c7a4f30dd1e3c94f84058281eb24eb988f148d7b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ $ mkdir build
 $ cd build/
 $ cmake ..
 $ make
-$ ./nothing <level-file>
+$ ./nothing ../levels/level-01.txt
 $ ./nothing_test
 ```
 
@@ -39,14 +39,15 @@ All of the levels reside in the [./levels/] folder. Use
 
 1. `$ inkscape ./levels/level.svg &`
 2. `$ ./build/nothing ./levels/level.txt &`
-3. `$ make watch`
-4. Edit Level in Inkscape and Save
-5. Switch to the Game and reload level by pressing Q
-6. Go to 1
+3. `$ cd ./levels/`
+4. `$ make watch`
+5. Edit Level in Inkscape and Save
+6. Switch to the Game and reload level by pressing Q
+7. Go to 5
 
 ### Objects Reference
 
-#### <rect/>
+#### SVG rect node
 
 | Regex of id  | Description                                                                                                       |
 |--------------|-------------------------------------------------------------------------------------------------------------------|
@@ -59,9 +60,11 @@ All of the levels reside in the [./levels/] folder. Use
 | `background` | Defines the **color** of the background. **Position and size are ignored**.                                       |
 | `backrect.*` | Defines the **size** and **position** of a solid block in the background.                                         |
 
-#### <text/>
+#### SVG text node
 
-- `id="label.*"`
+| Regex of id | Description                                                                |
+|-------------|----------------------------------------------------------------------------|
+| `label.*`   | Defines **position** and **text** of a in-game label. **Size is ignored**. |
 
 ## Build on Windows