Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix readme files about unit test scenarios
- Loading branch information
Showing
2 changed files
with
8 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
This is place to put macros that are only usefull for running unit tests. | ||
This is place to put macros that are only useful for running unit tests. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,10 @@ | ||
This is place to put any scenarios used by C++ unit tests. | ||
This directory contains both the scenarios used by C++ unit tests and those which are | ||
WML unit tests. | ||
|
||
It is good idea to reuse same scenario file as much as possible and just inject wml to that. | ||
Injection can be done creating config object with event code inside and then registering that | ||
For the C++ unit tests, it is recommended to reuse the same scenario file as much as possible | ||
and just inject WML into it. | ||
Injection can be done by adding a config object containing event code and then registering that | ||
manually for game_events. | ||
|
||
It is also a good place to put scenarios which are WML unit tests. | ||
WML unit tests are self-contained scenario files to test a specific area of WML. They can be | ||
implemented with the GENERIC_UNIT_TEST macro. |