Improve README.md
Noticeability
#1405
Open
+10
−8
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What I have done and why
Highlighted Note in
README.md
to improve noticeability.You can see the preview in here
Fix #1422
Note
You should not run
./gradlew test
or./gradlew connectedAndroidTest
as this will executetests against all build variants which is both unecessary and will result in failures as only the
demoDebug
variant is supported. No other variants have any tests (although this might change in future).Note
The known correct screenshots stored in this repository are recorded on CI using Linux. Other
platforms may (and probably will) generate slightly different images, making the screenshot tests fail.
When working on a non-Linux platform, a workaround to this is to run
recordRoborazziDemoDebug
on themain
branch before starting work. After making changes,verifyRoborazziDemoDebug
will identify onlylegitimate changes.
Note
The baseline profile needs to be re-generated for release builds that touch code which changes app startup.
How I'm testing it
Choose at least one: