docs: Update README.md

SUSTech-CPP-Recurse-Box · Jan 22, 2024 · e8a16d3 · e8a16d3
1 parent 42560de
commit e8a16d3
Show file tree

Hide file tree

Showing 11 changed files with 25 additions and 14 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -25,7 +25,7 @@
 
 cmake_minimum_required(VERSION 3.6)
 
-set(APP_NAME SoCoBan)
+set(APP_NAME Sokoban)
 
 project(${APP_NAME})
 

diff --git a/README.md b/README.md
@@ -23,21 +23,32 @@ Tutorial video of sample: https://www.bilibili.com/video/BV1bs4y1H7dD
 
 ### Well Come to Recurse Box!
 
-| Event       | Action                     |
-| ----------- | -------------------------- |
-| W A S D     | move up, down, left, right |
-| Mouse wheel | zoom in / out              |
-| R           | Restart                    |
-| Backspace ← | Undo one step              |
+We completed this project within almost 72 hours, so it was inevitable that there would be some imperfections. Think of this project as a mini Game Jam!
+
+#### Main Menu
+
+![main_frame](docs/img/main_frame.png)
+
+#### Help Page
+
+![help](docs/img/help.png)
+
+#### Level Select
+
+![level_select](docs/img/level_select.png)
 
 **Level-function mapping: [here](Resources/level/)**
 
-#### Box Example:
+#### Level Sample
+
+![level_sample1](docs/img/level_sample1.png)
+
+![level_sample2](docs/img/level_sample2.png)
+
+#### Load Game Page
+
+![load](docs/img/load.png)
 
-<img src="Resources/MainMenu/boxes/player.png" alt="player" style="zoom:25%;" /> Player
-<img src="Resources/MainMenu/boxes/traget_player.png" alt="traget_player" style="zoom:25%;" />Player Target
-<img src="Resources/MainMenu/boxes/default_box.png" alt="default_box" style="zoom:25%;" />Box
-<img src="Resources/MainMenu/boxes/target_box.png" alt="target_box" style="zoom:25%;" /> Box Target
-<img src="Resources/MainMenu/boxes/boundary.png" alt="boundary" style="zoom:25%;" />Boundary
-<img src="Resources/MainMenu/boxes/panel.png" alt="panel" style="zoom:25%;" />Floor
+#### Custom Design Game
 
+![design](docs/img/design.png)
diff --git a/Resources/MainMenu/net_off.png b/Resources/MainMenu/net_off.png
diff --git a/Resources/MainMenu/net_on.png b/Resources/MainMenu/net_on.png
diff --git a/docs/img/design.png b/docs/img/design.png
diff --git a/docs/img/help.png b/docs/img/help.png
diff --git a/docs/img/level_sample1.png b/docs/img/level_sample1.png
diff --git a/docs/img/level_sample2.png b/docs/img/level_sample2.png
diff --git a/docs/img/level_select.png b/docs/img/level_select.png
diff --git a/docs/img/load.png b/docs/img/load.png
diff --git a/docs/img/main_frame.png b/docs/img/main_frame.png