Add TODO(#933)

[nothing.git] / README.md

diff --git a/README.md b/README.md
index 4011828c18695009994a08cfbe9257d8ff753707..d3fd2a48d5dcf5eac9a330d2eacfca03727cafc6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -55,8 +55,8 @@ $ mkdir build
 $ cd build/
 $ cmake ..
 $ make
-$ ./nothing ../levels/
-$ ./nothing_test
+$ cd ../data/
+$ ../build/nothing
 ```
 
 ### Windows
@@ -70,9 +70,11 @@ $ ./nothing_test
 > 7z x SDL2-devel-2.0.9-VC.zip
 > move SDL2-2.0.9 SDL2
 > mkdir build
+> cd build
 > cmake ..
 > cmake --build .
-> nothing ..\levels
+> cd ../data/
+> ..\build\nothing
 ```
 
 ## Controls
@@ -91,6 +93,7 @@ $ ./nothing_test
 | `q`     | Reload the current level preserving the Player's position   |
 | `p`     | Toggle game pause                                           |
 | `l`     | Toggle transparency on objects. Useful for debugging levels |
+| `TAB`   | Switch to Level Editor                                      |
 
 #### Gamepad
 
@@ -107,58 +110,7 @@ $ ./nothing_test
 | `Enter`   | Evaluate the expression  |
 | `Up/Down` | Traverse console history |
 
-## Editing Levels
-
-Generally creating a level looks like:
-
-```
-SVG File -> Custom Level File -> Game
-```
-
-To convert SVG to the level file and run svg2level program:
-
-```console
-$ ./build/svg2level compile <svg-file> <level-file>
-```
-
-All of the levels reside in the [./levels/] folder. Use
-[./levels/Makefile] to automatically rebuild all levels:
-
-```console
-$ cd levels/     # you must be inside of the `levels/` folder
-$ make
-```
-
-### Level Editing Workflow
-
-1. `$ inkscape ./levels/level.svg &`
-2. `$ ./build/nothing ./levels/level.txt &`
-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
-
-#### SVG rect node
-
-| Regex of id  | Description                                                                                                       |
-|--------------|-------------------------------------------------------------------------------------------------------------------|
-| `player`     | Defines the **position** of the Player. **Size is ignored**.                                                      |
-| `rect.*`     | Defines the **size** and **position** of an impenetrable platform block                                           |
-| `box.*`      | Defines the **size** and **position** of a rigid box that obeys the physics of the game                           |
-| `region(.*)` | Defines the **size** and **position** of a region that hides the Goals. `\1` defines the id of the Goal to hide.  |
-| `goal(.*)`   | Defines the **position** of the goal. **Size is ignored**. `\1` defines the id of the region that hides the goal. |
-| `lava.*`     | Defines the **position** and **size** of a lava block.                                                            |
-| `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.                                         |
-
-#### SVG text node
-
-| Regex of id | Description                                                                |
-|-------------|----------------------------------------------------------------------------|
-| `label.*`   | Defines **position** and **text** of a in-game label. **Size is ignored**. |
+<!-- TODO(#914): Level Editor is not documented -->
 
 ## Support