Skip to content

Commit 60419cd

Browse files
committed
Added README for APK sizing
1 parent 85db524 commit 60419cd

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

tools/apksize/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# APK Size Tooling
2+
3+
## Purpose
4+
5+
This tooling measures the size of APKs using Firebase. The APKs are simple apps
6+
that exercise only a small faction of the API surface. These numbers help to
7+
show how an app's size might grow if Firebase is included.
8+
9+
## How to Use
10+
11+
There are two tasks defined in this subproject: generateMeasurements and
12+
uploadMeasurements. The former gathers the measurements and writes them to a
13+
file in the build directory. The latter is invoked by CI and uploads the report
14+
to an SQL database.
15+
16+
The generateMeasurements task may be manually run with `./gradlew -q
17+
generateMeasurements -Ppull_request=999`. A pull request number is required to
18+
generate the report.
19+
20+
## Current Support
21+
22+
All projects in this repository are supported with an aggressive ProGuard
23+
profile. Less aggressive ProGuard profiles will be added at a future date.

0 commit comments

Comments
 (0)