Skip to content

Commit

Permalink
Touchup readme & Prepare 0.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
cmyr committed Mar 17, 2019
1 parent 7efc216 commit 5a53642
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "cargo-instruments"
version = "0.1.0"
version = "0.1.1"
authors = ["Colin Rofls <[email protected]>"]
license = "MIT"
description = "Generate Xcode Instruments trace files for binary targets."
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,23 @@ that can be viewed in the Instruments app.
## Installation

First, ensure that you are running macOS, with Cargo, Xcode, and the Xcode Command Line
Tools installed; then run with **`cargo install cargo-instruments`**.
Tools installed; then install with **`cargo install cargo-instruments`**.

## Use

### basic usage

`cargo-instruments` requires a binary target to run. By default, it will try to
build the current crate's `main.rs`. You can specify an alternative binary by
using the `--bin` and `--example` flags.
using the `--bin` or `--example` flags.

_Generate a new trace file_ (by default saved in `/target/instruments`)

```sh
$ cargo instruments [template] [--bin foo | --example bar] [--out out_file]
```

_Open the file in Instruments.app_
_Open the file in Instruments.app_ (or pass `--open` to open automatically)

```sh
$ open target/instruments/my_bin_YYYY-MM-DD-THH:MM:SS.trace
Expand Down

0 comments on commit 5a53642

Please sign in to comment.