Skip to content

Commit 90b992b

Browse files
authored
Improve README.md Noticeability (#1405)
* Highlight Note. Change-Id: I79b564cf56428dd278d257da2c75f57312067148 * Highlight Note. Change-Id: I9ec8e49a3fcd88de9de1838b3003ed81150d4cf6 * Change style. * Add newline. Change-Id: I8d443f63ba91082fcd6754a9b1f4a657091a1a11 * Add newline and emphasis. Change-Id: I7fd4d80fde91ede9c4a784c04ebb895fa43bf015
1 parent 6bf2d04 commit 90b992b

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,8 @@ To run the tests execute the following gradle tasks:
115115
(see below for explanation). To avoid this, run `recordRoborazziDemoDebug` prior to running unit tests.
116116
- `connectedDemoDebugAndroidTest` run all instrumented tests against the `demoDebug` variant.
117117

118-
**Note:** You should not run `./gradlew test` or `./gradlew connectedAndroidTest` as this will execute
118+
> [!NOTE]
119+
> You should not run `./gradlew test` or `./gradlew connectedAndroidTest` as this will execute
119120
tests against _all_ build variants which is both unnecessary and will result in failures as only the
120121
`demoDebug` variant is supported. No other variants have any tests (although this might change in future).
121122

@@ -138,7 +139,9 @@ stored in `modulename/src/test/screenshots`.
138139
- `compareRoborazziDemoDebug` create comparison images between failed tests and the known correct
139140
images. These can also be found in `modulename/src/test/screenshots`.
140141

141-
**Note on failing screenshot tests:** The known correct screenshots stored in this repository are recorded on CI using Linux. Other
142+
> [!NOTE]
143+
> **Note on failing screenshot tests**
144+
> The known correct screenshots stored in this repository are recorded on CI using Linux. Other
142145
platforms may (and probably will) generate slightly different images, making the screenshot tests fail.
143146
When working on a non-Linux platform, a workaround to this is to run `recordRoborazziDemoDebug` on the
144147
`main` branch before starting work. After making changes, `verifyRoborazziDemoDebug` will identify only

0 commit comments

Comments
 (0)