Add build/test instructions to the README

Differential Revision: D41562403

fbshipit-source-id: 4478d4cfca9d487f03fdf3b60b2805bc65d4bca4
This commit is contained in:
Jason White 2022-11-28 16:28:02 -08:00 committed by Facebook GitHub Bot
parent 5ff7f23e25
commit 8909065ec3

View file

@ -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