diff options
| author | Aram Drevekenin <aram@poor.dev> | 2019-11-25 22:24:05 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-11-25 22:24:05 +0100 |
| commit | b31d05394748969767483e04638aee3c759dd5cf (patch) | |
| tree | 9831dc0db6e53a490e70cb5cf1856e69441bbbaf /README.md | |
| parent | a0a3cd5c7c81a92eb297bd13ac32972a9b79df56 (diff) | |
docs(readme): update contributing section
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 10 insertions, 0 deletions
@@ -51,5 +51,15 @@ what -i eth0 --raw | grep firefox ### Contributing Contributions of any kind are very welcome. If you'd like a new feature (or found a bug), please open an issue or a PR. +To set up your development environment: +1. Clone the project +2. `cargo run -- -i <network interface name>` (you can often find out the name with `ifconfig` or `iwconfig`). You might need root privileges to run this application, so be sure to use (for example) sudo. + +To run tests: `cargo test` + +Note that at the moment the tests do not test the os layer (anything in the `os` folder). + +If you are stuck, unsure about how to approach an issue or would like some guidance, you are welcome to contact: aram@poor.dev + ### License MIT |