diff --git a/README.md b/README.md index ed46d5d..bb928b8 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,43 @@ -# r-lanscan +# R-LANSCAN/ -An ARP and SYN network scanning library and cli written in rust! This is the +An ARP and SYN network scanning library, cli, and ui written in rust! This is the rust version of [go-lanscan] +**Table of contents** +- [R-LANSCAN/](#r-lanscan) +- [Projects](#projects) +- [Testing](#testing) +# Projects + +- [r-lanlib](./r-lanlib/README.md) +- [r-lanscan](./r-lanscan/README.md) +- [r-lanui](./r-lanui/README.md) + +# Testing + +Prerequisites + +- install llvm-cov + +```zsh +cargo +stable install cargo-llvm-cov --locked +``` + +Run tests + +```zsh +# Run all tests +cargo test + +# Run all tests and print coverage +cargo llvm-cov + +# Run all tests and generate html report +cargo llvm-cov --html + +# Run tests for specific project +cargo test -p r-lanlib +``` [go-lanscan]: https://github.com/robgonnella/go-lanscan diff --git a/r-lanlib/README.md b/r-lanlib/README.md new file mode 100644 index 0000000..78ce936 --- /dev/null +++ b/r-lanlib/README.md @@ -0,0 +1,3 @@ +# R-LANLIB + +Library package for performing ARP and SYN scanning of a LAN diff --git a/r-lanscan/README.md b/r-lanscan/README.md new file mode 100644 index 0000000..d73747c --- /dev/null +++ b/r-lanscan/README.md @@ -0,0 +1,3 @@ +# R-LANSCAN + +CLI for performing ARP and SYN scanning of LAN diff --git a/r-lanui/README.md b/r-lanui/README.md new file mode 100644 index 0000000..fedfcc8 --- /dev/null +++ b/r-lanui/README.md @@ -0,0 +1,3 @@ +# R-LANUI + +UI for discovering and managing on premise LAN devices