Skip to content

Commit

Permalink
Add build/test instructions to the README
Browse files Browse the repository at this point in the history
Differential Revision: D41562403

fbshipit-source-id: 4478d4cfca9d487f03fdf3b60b2805bc65d4bca4
  • Loading branch information
jasonwhite authored and facebook-github-bot committed Nov 29, 2022
1 parent 5ff7f23 commit 8909065
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,25 @@ The tool can stipulate exactly which events streams it ***subscribes*** to.
The tool itself is stateful, maintaining state between consecutive
invocations.

## Building and Testing

Reverie needs the following system-level dependencies:
```
sudo apt install pkg-config libunwind-devel
```
(These are required to get backtraces from the guest process.)

To test, run:
```
cargo test -- --test-threads=1
```

To run the `strace` example:
```
cd reverie-examples
cargo run --bin strace -- ls
```

## Usage

Currently, there is only the `reverie-ptrace` backend which uses `ptrace` to
Expand Down

0 comments on commit 8909065

Please sign in to comment.