Skip to content

Commit

Permalink
Merge pull request #62 from nowsprinting/chore/fix_readme
Browse files Browse the repository at this point in the history
Fix README
  • Loading branch information
nowsprinting committed Mar 20, 2024
2 parents c8f1eb7 + 8727843 commit b41c616
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public class MyTestClass
}
```

> **Note**
> [!NOTE]
> In batchmode, open `GameView` window.

Expand Down Expand Up @@ -72,11 +72,11 @@ public class MyTestClass
}
```

> **Warning**
> [!WARNING]
> Wait for one frame to apply resolution.
> However, if used with [CreateSceneAttribute](#CreateScene) or [LoadSceneAttribute](#LoadScene), wait is not necessary.
> **Note**
> [!NOTE]
> In batchmode, open `GameView` window.

Expand Down Expand Up @@ -105,7 +105,7 @@ public class MyTestClass
}
```

> **Note**
> [!NOTE]
> In batchmode, open `GameView` window.

Expand Down Expand Up @@ -204,7 +204,7 @@ public class MyTestClass
}
```

> **Note**
> [!NOTE]
> - Create scene run after `OneTimeSetUp` and before `SetUp`
> - Create or not `Main Camera` and `Directional Light` can be specified with parameters (default is not create)
Expand Down Expand Up @@ -241,7 +241,7 @@ public class MyTestClass
}
```

> **Note**
> [!NOTE]
> - Load scene run after `OneTimeSetUp` and before `SetUp`
> - Scene file path is starts with `Assets/` or `Packages/`. And package name using `name` instead of `displayName`, when scenes in the package. (e.g., `Packages/com.nowsprinting.test-helper/Tests/Scenes/Scene.unity`)
Expand Down Expand Up @@ -274,11 +274,11 @@ public class MyTestClass
}
```

> **Warning**
> [!WARNING]
> - Do not attach to Edit Mode tests.
> - `GameView` must be visible. Use [FocusGameViewAttribute](#FocusGameView) or [GameViewResolutionAttribute](#GameViewResolution) if running on batch mode.
> **Note**
> [!NOTE]
> If you want to take screenshots at any time, use the [ScreenshotHelper](#ScreenshotHelper) class.

Expand Down Expand Up @@ -361,7 +361,7 @@ public class MyTestClass
}
```

> **Note**
> [!NOTE]
> When used with operators, use it in method style. e.g., `Is.Not.Destroyed()`

Expand Down Expand Up @@ -405,7 +405,7 @@ public class MyTestClass
}
```

> **Warning**
> [!WARNING]
> - Do not call from Edit Mode tests.
> - Must be called from main thread.
> - `GameView` must be visible. Use [FocusGameViewAttribute](#FocusGameView) or [GameViewResolutionAttribute](#GameViewResolution) if running on batch mode.
Expand Down Expand Up @@ -485,17 +485,17 @@ Add this repository as a submodule to the Packages/ directory in your project.
git submodule add https://github.com/nowsprinting/test-helper.git Packages/com.nowsprinting.test-helper
```

> [!WARNING]
> Required install packages for running tests (when adding to the `testables` in package.json), as follows:
> - [UniTask](https://github.com/Cysharp/UniTask) package v2.3.3 or later
Generate a temporary project and run tests on each Unity version from the command line.

```bash
make create_project
UNITY_VERSION=2019.4.40f1 make -k test
```

> **Warning**
> Required install packages for running tests (when adding to the `testables` in package.json), as follows:
> - [UniTask](https://github.com/Cysharp/UniTask) package v2.3.3 or later


## Release workflow
Expand Down

0 comments on commit b41c616

Please sign in to comment.