README.md
1# Trebuchet
2
3Trebuchet is a Kotlin library for parsing and analyzing Android trace files generated by the `atrace` or `systrace` commands. This is not an officially supported Google product.
4
5## Library
6
7The code for the Trebuchet library can be found in the `core/` directory.
8
9## Bundled Programs
10
11Trebuchet comes bundled with several programs for analyzing one or more trace files.
12
13### Startup Analyzer
14
15The Startup Analyzer program takes a trace file, detects any startup events that occurred during the traced time period, and prints information about the events. If Trebuchet is built using the Android build system, there will be a StartupAnalyzerKt program placed into a directory that is a member of the PATH system variable. If you wish to use Gradle, you can use the `startup-analyzer.sh` script located in the `scripts/` directory.
16
17### Startup Summarizer
18
19The Startup Summarizer program takes a set of trace files, detects startup events in each file, and computes average and standard deviation for startup stats, broken down by program name, compiler filter, and cache status. If Trebuchet is built using the Android build system, there will be a StartupSummarizerKt program placed into a directory that is a member of the PATH system variable. If you wish to use Gradle, you can use the `startup-summarizer.sh` script located in the `scripts/` directory.
20
21## Helper Scripts
22
23The `scripts/` directory contains a shell script called `run-startup.sh`, which will start a trace, launch an activity given a package name and an activity name, transfer the trace file to the host machine, and run the StartupAnalyzer.
24