Skip to content

docs: update docs #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
toidiu merged 1 commit into from
May 19, 2026
Merged

docs: update docs #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Rust
/target/
*plot*.html
reports
report

# Viewer
## Node modules (for Tailwind in viewer)
Expand Down
20 changes: 14 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,29 @@ A testing utility for measuring networking protocols.
## Getting started

### Platform Support
**Linux**
- Network simulation is created with tc (i.e. netem and htb).
**Linux (Debian)**
Network simulation is created with tc (i.e. netem and htb).

Prerequisite:

```
sudo apt update
sudo apt install iproute2 ethtool
```

**macOS**
- Due to lack of tc support on macOS, there is not network simulation and the
Due to lack of tc support on macOS, there is not network simulation and the
results are less interesting. However, development is still possible.


### Run

```
git clone git@github.com:toidiu/boar.git && git submodule update --init
git clone git@github.com:toidiu/boar.git
git submodule update --init
cargo test

cargo build;
cargo build

// tc/netem requires sudo permission
sudo ./target/debug/boar
Expand All @@ -37,7 +45,7 @@ sudo ip netns exec ns_c1 sh -c "RUST_LOG=info ../quiche/target/release/quiche-cl
```

## Tasks
- [ ] render report output as a html page
- [x] render report output as a html page
- [ ] allow for running multiple server binaries
- [ ] compare stats between different builds

Loading