Skip to content

Commit

Permalink
Add barebones README.md for Caliper to replace the old README that ha…
Browse files Browse the repository at this point in the history
…d out of date information.

Also add COPYING file internally so we have one fewer file in the external repo that isn't present internally.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=176656337
  • Loading branch information
cgdecker committed Nov 22, 2017
1 parent 29f225d commit d495ae4
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 8 deletions.
8 changes: 0 additions & 8 deletions README

This file was deleted.

33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Caliper

Caliper is a tool for measuring Java code performance, primarily focused on
microbenchmarks.

## Building

To build the JVM version of Caliper (the only supported version at the moment),
run:

```shell
mvn clean install -am -pl caliper
```

### Android

Caliper currently has a number of artifacts related to Android. These are in
a transitional state and no easy way to run Caliper benchmarks on Android is
currently available.

If you are interested in building the Android artifacts for any reason, you can
run:

```shell
mvn clean install -am -pl caliper-android
```

Note that for these artifacts to build, you must have an `ANDROID_HOME`
environment variable set to the location of an Android SDK containing the file
`platforms/android-25/android.jar`. Alternatively, you can pass
`-Dandroid.home=<path>` to your `mvn` command to set the Android SDK directory
that way, and/or `-Dandroid.sdk.version=<version>` to specify a version other
than `25` (but note that the build may not work with a version lower than `25`).

0 comments on commit d495ae4

Please sign in to comment.