Merge pull request #751 from android/st/document-compiler-metrics-command

Added Compose compiler metrics generation command to README.md

README.md

@@ -132,7 +132,14 @@ The app uses adaptive layouts to
 
 Find out more about the [UI architecture here](docs/ArchitectureLearningJourney.md#ui-layer).
 
-# Baseline profiles
+# Performance
+
+## Benchmarks
+
+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.
+
+## 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.
@@ -144,6 +151,19 @@ To generate the baseline profile, select the `benchmark` build variant and run t
 `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).
 
+## Compose compiler metrics
+
+Run the following command to get and analyse compose compiler metrics:
+
+```
+./gradlew assembleRelease -PenableComposeCompilerMetrics=true -PenableComposeCompilerReports=true
+```
+
+The reports files will be added to build/compose-reports in each module. The metrics files will be 
+added to build/compose-metrics in each module.
+
+For more information on Compose compiler metrics, see [this blog post](https://medium.com/androiddevelopers/jetpack-compose-stability-explained-79c10db270c8).
+
 # License
 
 **Now in Android** is distributed under the terms of the Apache License (Version 2.0). See the