diff --git a/.gitignore b/.gitignore index fc52fba..3911fa1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,7 @@ # Rust /target/ *plot*.html -reports +report # Viewer ## Node modules (for Tailwind in viewer) diff --git a/README.md b/README.md index 75c315e..19a6811 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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