Skip to content

Commit

Permalink
docs: added profiling info
Browse files Browse the repository at this point in the history
  • Loading branch information
zleyyij authored Feb 17, 2024
1 parent 8952e51 commit 822a766
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,17 @@ The resulting executable will be located in `./target/release/`.
## Testing
Testing also requires the rust toolchain installed.

To test the project:
To _test_ the project:
```
cargo test
```

To _profile_ the project, you'll need `cargo flamegraph` installed (`cargo install flamegraph`):
```
cargo flamegraph --root --unit-test -- [TEST_NAME]
```
Where `[TEST_NAME]` is the test you want to profile. There are other ways to profile different parts of the code, but you can figure that out yourself.

## Configuration
By default, the application listens on port `3000`, although that can be configured by setting the `HWAPI_PORT` environment variable or by passing `-p`/`--port`.

Expand Down

0 comments on commit 822a766

Please sign in to comment.