Update README.md

pull/1933/head
BYRON AANTHONY MARTINEZ 2 months ago committed by GitHub
parent ba1a463498
commit 2fce4081f1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -131,7 +131,7 @@ to verify that the navigation is displayed correctly on different screen sizes
Now In Android uses [Roborazzi](https://github.com/takahirom/roborazzi) to run screenshot tests Now In Android uses [Roborazzi](https://github.com/takahirom/roborazzi) to run screenshot tests
of certain screens and UI components. When working with screenshot tests the following gradle tasks are useful: of certain screens and UI components. When working with screenshot tests the following gradle tasks are useful:
- `verifyRoborazziDemoDebug` run all screenshot tests, verifying the screenshots against the known run all screenshot tests, verifying the screenshots against the known
correct screenshots. correct screenshots.
- `recordRoborazziDemoDebug` record new "known correct" screenshots. Use this command when you have - `recordRoborazziDemoDebug` record new "known correct" screenshots. Use this command when you have
made changes to the UI and manually verified that they are rendered correctly. Screenshots will be made changes to the UI and manually verified that they are rendered correctly. Screenshots will be
@ -166,24 +166,13 @@ Each theme also supports dark mode.
The app uses adaptive layouts to The app uses adaptive layouts to
[support different screen sizes](https://developer.android.com/guide/topics/large-screens/support-different-screen-sizes). [support different screen sizes](https://developer.android.com/guide/topics/large-screens/support-different-screen-sizes).
Find out more about the [UI architecture here](docs/ArchitectureLearningJourney.md#ui-layer). Find out more about the [UI architecture here](docs/ArchitectureLearningJourney.md#ui-layer)
# Performance
## Benchmarks
Find all tests written using [`Macrobenchmark`](https://developer.android.com/topic/performance/benchmarking/macrobenchmark-overview) Find all tests written using [`Macrobenchmark`](https://developer.android.com/topic/performance/benchmarking/macrobenchmark-overview)
in the `benchmarks` module. This module also contains the test to generate the Baseline profile. in the `benchmarks` module. This module also contains the test to generate the Baseline profile. [`app/src/main/baseline-prof.txt`](app/src/main/baseline-prof.txt).
## Baseline profiles
The baseline profile for this app is located at [`app/src/main/baseline-prof.txt`](app/src/main/baseline-prof.txt).
It contains rules that enable AOT compilation of the critical user path taken during app launch. It contains rules that enable AOT compilation of the critical user path taken during app launch.
For more information on baseline profiles, read [this document](https://developer.android.com/studio/profile/baselineprofiles). For more information on baseline profiles,a
>
> [!NOTE]
> The baseline profile needs to be re-generated for release builds that touch code which changes app startup.
To generate the baseline profile, select the `benchmark` build variant and run the To generate the baseline profile, select the `benchmark` build variant and run the
`BaselineProfileGenerator` benchmark test on an AOSP Android Emulator. `BaselineProfileGenerator` benchmark test on an AOSP Android Emulator.
Then copy the resulting baseline profile from the emulator to [`app/src/main/baseline-prof.txt`](app/src/main/baseline-prof.txt). Then copy the resulting baseline profile from the emulator to [`app/src/main/baseline-prof.txt`](app/src/main/baseline-prof.txt).
@ -195,7 +184,7 @@ Run the following command to get and analyse compose compiler metrics:
```bash ```bash
./gradlew assembleRelease -PenableComposeCompilerMetrics=true -PenableComposeCompilerReports=true ./gradlew assembleRelease -PenableComposeCompilerMetrics=true -PenableComposeCompilerReports=true
``` ```
look how this assholes lie or per our pr assholes
The reports files will be added to [build/compose-reports](build/compose-reports). The metrics files will also be The reports files will be added to [build/compose-reports](build/compose-reports). The metrics files will also be
added to [build/compose-metrics](build/compose-metrics). added to [build/compose-metrics](build/compose-metrics).

Loading…
Cancel
Save