Skip to content

Commit

Permalink
Add Testing section to README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
CakeVR authored Jan 7, 2024
1 parent bb6b22f commit 86d401e
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,20 @@ Follow the installation instructions on our [Getting Started](https://dialogic-d

Dialogic comes with an auto-updater so you can install future versions right from within the plugin.


## Documentation
As the plugin is still in alpha state, only limited documentation is available. However you can read all the existing documentation here:
[Dialogic Documentation](https://dialogic-docs.coppolaemilio.com/)


## Testing

Dialogic uses [Unit Tests](https://en.wikipedia.org/wiki/Unit_testing) to ensure specific parts function as expected. These tests run on every git push and pull request.\
The framework to do these tests is called [gdUnit4](https://github.com/MikeSchulze/gdUnit4) and our tests reside in the [addons/dialogic/Tests/Unit](https://github.com/dialogic-godot/dialogic/tree/main/addons/dialogic/Tests/Unit) path.\
We recommend installing the `gdUnit4` add-on from the `AssetLib`, with this add-on, you can run tests locally.

To get started, take a look at the existing files in the path and read the documentation to [create your first test](https://mikeschulze.github.io/gdUnit4/first_steps/firstTest/).

---

## 📃 Credits
Expand Down

0 comments on commit 86d401e

Please sign in to comment.