Skip to content

Commit

Permalink
Update booster-task-analyser/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsonlee committed Jun 11, 2022
1 parent a03acd9 commit 1430472
Showing 1 changed file with 28 additions and 6 deletions.
34 changes: 28 additions & 6 deletions booster-task-analyser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,27 @@

This module is used for static analysing.

## Getting Started
## Performance Analysis

Start analysing by executing the following command
Start performance analysis by executing the following command

```bash
./gradlew analyseDebug
./gradlew analysePerformanceDebug
```

or

```bash
./gradlew analyseRelease
./gradlew analysePerformanceRelease
```

or

```bash
./gradlew analyse
./gradlew analysePerformance
```

## Analyser Reports
### Analyser Reports

The [dot](https://www.graphviz.org/doc/info/lang.html) format reports is located at `build/reports/${variant}/booster-task-analyser/`, you can convert the dot files to PNGs by using the following command:

Expand Down Expand Up @@ -54,3 +54,25 @@ or configured in the `gradle.properties`:
```properties
booster.task.analyser.whitelist=file:///Users/booster/whitelist.txt
```

## Reference Analysis

Start reference analysis by executing the following command

```bash
./gradlew analyseReferenceDebug
```

or

```bash
./gradlew analyseReferenceRelease
```

or

```bash
./gradlew analyseReference
```

The reports are located at `build/reports/booster-task-analyser/reference/`

0 comments on commit 1430472

Please sign in to comment.