docs: fix grammatical errors

ShenMian · ShenMian · commit 28efb6ac1593 · 2024-02-06T19:07:52.000+08:00
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ A sokoban with solver.
   <p align="center"><img src="./docs/assets/auto_crate_push.gif" width=50%></p>
 
 - [**Level management**](docs/level_management.md):
-  Levels and solutions are stored in a database.
+  Levels and solutions are stored in the database.
 
 - [**Customizing**](docs/customizing.md):
   Options can be customized via configuration file.
@@ -24,7 +24,7 @@ A sokoban with solver.
   Supports moving and zooming the map. When switching levels, the zoom will be automatically adjusted to fit the window size.
 
 - **Player character animation**:
-  Player character have smooth movement and movement animations in different directions.
+  Player character has smooth movement and movement animations in different directions.
 
 - **Front-end and back-end separation**:
   Backend code (such as solvers) does not depend on frontend (such as Bevy).
@@ -34,13 +34,13 @@ A sokoban with solver.
 ### Mouse
 
 | Key                                   | Action                                   |
-|---------------------------------------|------------------------------------------|
+| ------------------------------------- | ---------------------------------------- |
 | Click `Left` on player reachable area | Move the character to this position      |
 | Click `Left` on a crate               | Show the pushable area of the crate      |
 | Click `Left` on crate pushable area   | Push the selected crate to this position |
 | Hold `Right` and drag                 | Adjust viewport                          |
-| Click `Button 4`                      | Undo last push                           |
-| Click `Button 5`                      | Redo last push                           |
+| Click `Button 4`                      | Undo the last push                       |
+| Click `Button 5`                      | Redo the last push                       |
 | Scroll `Middle`                       | Zoom in/out                              |
 
 ### Keyboard
@@ -51,8 +51,8 @@ A sokoban with solver.
 | Arrow keys                | Move the character                         |
 | `[`/`]`                   | Switch to the previous/next level          |
 | `Ctrl` + `[`/`Ctrl` + `]` | Switch to the previous/next unsolved level |
-| `Ctrl` + `Z`              | Undo last push                             |
-| `Ctrl` + `Shift` + `Z`    | Redo last push                             |
+| `Ctrl` + `Z`              | Undo the last push                         |
+| `Ctrl` + `Shift` + `Z`    | Redo the last push                         |
 | `Esc`                     | Reset current level                        |
 | `-`/`=`                   | Zoom in/out                                |
 | `Ctrl` + `V`              | Import levels from clipboard               |
@@ -63,20 +63,20 @@ A sokoban with solver.
 
 ### Keyboard (Vim)
 
-| Key             | Action                            |
-|-----------------|-----------------------------------|
-| `H`/`J`/`K`/`L` | Move the character                |
-| `U`             | Undo last push                    |
-| `Ctrl` + `R`    | Redo last push                    |
+| Key             | Action             |
+| --------------- | ------------------ |
+| `H`/`J`/`K`/`L` | Move the character |
+| `U`             | Undo the last push |
+| `Ctrl` + `R`    | Redo the last push |
 
 ### Controller
 
 | Key            | Action                            |
 | -------------- | --------------------------------- |
 | D-Pad          | Move the character                |
 | `LB`/`RB`      | Switch to the previous/next level |
-| `B`/`Circle`   | Undo last push                    |
-| `A`/`Cross`    | Redo last push                    |
+| `B`/`Circle`   | Undo the last push                |
+| `A`/`Cross`    | Redo the last push                |
 | `LT`/`RT`      | Zoom in/out                       |
 | Right stick    | Adjust viewport                   |
 | `X`/`Square`   | Toggle instant move[^1]           |
diff --git a/docs/auto_move.md b/docs/auto_move.md
@@ -4,8 +4,8 @@
 
 <p align="center"><img src="assets/auto_crate_push.gif" width=70%></p>
 
-This feature can provide good assistance when users play larger levels.  
-At the same time, it also retains the traditional control method.
+This feature can significantly assist users when playing larger levels.  
+At the same time, it also maintains the traditional control method.
 
 Clicking on a crate will display all the points that the crate can reach (without moving other crates).
 
@@ -15,7 +15,7 @@ Take Microban #155 as an example:
 
 Clicking on one of the points will automatically push the selected crate to that position.
 
-In this case, user can click on the target, and the character will automatically push the selected crate to the target to complete the level.
+In this case, the user can click on the target, and the character will automatically push the selected crate to the target to complete the level.
 
 Some areas where the crates are reachable do not display points. This is because pushing the crate to those positions will lead to a deadlock and the player will be unable to continue completing the level.
 
@@ -31,10 +31,10 @@ User can also directly click on the player's reachable area without selecting th
 
 ## Controversial
 
-This feature is a bit controversial, with some people saying it's akin to cheating.
+This feature is a bit controversial, with some users saying it's akin to cheating.
 
 For simple levels, this does significantly reduce the level difficulty. An extreme example is a level with only a single crate and target, which means the player can complete it without having to do any reasoning.
 
-But for complex levels, the difficulty mainly lies in the complex pushing relationship between multiple crates, rather than the pushing of a single crate. This feature allows players to focus on more complex reasoning instead of repeating the simple work of pushing a single crate.
+But for challenging levels, the difficulty mainly lies in the intricate pushing relationship between multiple crates, rather than the pushing of a single crate. This feature allows players to focus on more complex reasoning instead of repeating the simple work of pushing a single crate.
 
 In addition, this feature is **optional**. Users can still use the traditional control methods.
diff --git a/docs/customizing.md b/docs/customizing.md
@@ -2,7 +2,7 @@
 
 ## Configuration
 
-User can configure settings by editing `config.toml` in the same directory. If the file does not exist, a default configuration file will be automatically generated when the program is run.
+The user can configure settings by editing `config.toml` in the same directory. If the file does not exist, a default configuration file will be automatically generated when the program is run.
 
 ```toml
 # Player movement animation speed, seconds per step.
@@ -25,4 +25,4 @@ For `solver` related configuration options, please refer to [Solver](./solver.md
 
 ## Keymap
 
-User can configure keymap by editing `keymap.toml` in the same directory. If the file does not exist, a default keymap configuration file will be automatically generated when the program is run.
+The user can configure keymap by editing `keymap.toml` in the same directory. If the file does not exist, a default keymap configuration file will be automatically generated when the program is run.
diff --git a/docs/level_management.md b/docs/level_management.md
@@ -16,10 +16,10 @@
 
 Supports importing levels in XSB format (support run-length encoding) from files or system clipboard:
 
-- Import from file: User can drag single or multiple level files in XSB format into the window.
-- Import from clipboard: If the level in XSB format is already in the clipboard, it can be imported by input action.
+- Import from files: The user can drag single or multiple level files in XSB format into the window.
+- Import from clipboard: If some levels in XSB format is already in the clipboard, it can be imported using the input action.
 
-The levels will be standardized first to prevent repeated import of the same or similar levels. The standardized levels are only used for deduplication, and the final imported levels are not standardized.
+The levels will first be standardized to prevent repeated import of the same or similar levels. The standardized levels are only used for deduplication, and the final imported levels are not standardized.
 
 Levels that meet the following conditions are considered similar:
 
diff --git a/docs/solver.md b/docs/solver.md
@@ -2,7 +2,7 @@
 
 <p align="center"><img src="assets/auto_solve.gif" width=70%></p>
 
-The solver can automatically solve simple levels.
+The solver can automatically solve levels of moderate complexity.
 
 ## Strategy
 
@@ -14,21 +14,21 @@ The solver can automatically solve simple levels.
 ## Lower bound calculation method
 
 - `MinimumPush`: Minimum push count to nearest target.
-- `MinimumMove`: Minimum move count to nearest target. (Slow, especially on maps with many crates or large areas)
-- `ManhattanDistance`: Manhattan distance to nearest target. (Fast, suitable for maps with many crates or large areas)
+- `MinimumMove`: Minimum move count to nearest target. (This method is slow, especially on maps with many crates or large areas)
+- `ManhattanDistance`: Manhattan distance to nearest target. (This method is fast, suitable for maps with many crates or large areas)
 
 ## Optimization
 
 - Deadlocks detection.
-  - Dead square deadlocks.
-  - Freeze deadlocks.
+  - Detects dead square deadlocks.
+  - Detects freeze deadlocks.
 - Tunnels detection.
 
 ## Statistics
 
 CPU       : 13th Gen Intel(R) Core(TM) i9-13900HX (Base speed: 2.20 GHz).  
 Threads   : 1.  
-Time limit: 10 sec.
+Time limit: 10 seconds.
 
 | Collection          | Total | Solved |
 | ------------------- | ----- | ------ |
@@ -38,7 +38,7 @@ Time limit: 10 sec.
 
 ## Visualization
 
-Supports visualization of the automatic solution process. This feature can be used to intuitively view the working status of the solver.
+Supports visualizing the automatic solution process. This feature can be used to intuitively view the working status of the solver.
 
 - Displays the optimal state obtained by the current solver.
 - Display the lower bound as a heat map.
