# protobash: a tool for testing/fuzzing protocol implementations

The intention for this tool is to solve an immediate problem I have verifying
some TCP code I'm working on.

This project is currently at the "hello, world" stage, expect to see some more
activity here over the next few weeks.

The idea is to use some sort of gtest-style syntax for describing what the tool
should do and what it should expect to happen. I will eventually extend it
beyond TCP, and will write it with that in mind, but TCP is my immediate use
case.

Contributions are welcome, see [`CONTRIBUTING.md`](CONTRIBUTING.md) for help
getting started.

## Building

protobash is built with Cargo, the standard Rust build tool.

Use `cargo build` to compile, and find the resulting binary in
`target/debug/osiris-client-linux`. You can also run `cargo build --release` for
a release build.

The intention is to always use the latest stable Rust.

## Documentation

Run `cargo doc --open` to open the documentation for both protobash and its
dependencies in a web browser.