diff --git a/README.md b/README.md index fb3b739..c5ed5ea 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ ## Overview -The IGMP Packet Generator is a specialized tool designed for generating various -types of Internet Group Management Protocol (IGMP) packets. +The IGMP Packet Generator (`igmpgen`) is a specialized tool designed for +generating various types of Internet Group Management Protocol (IGMP) packets. This tool is particularly useful for network administrators, developers, and researchers involved in testing and analyzing multicast network protocols. @@ -27,7 +27,7 @@ researchers involved in testing and analyzing multicast network protocols. For debian/ubuntu, simply type: ```shell-session -sudo apt-get install cmake libnet1-dev +sudo apt-get install cmake libnet1-dev gcc rpm ``` ## Install @@ -35,30 +35,31 @@ sudo apt-get install cmake libnet1-dev ### Clone the Repository (if applicable): ```bash -git clone [repository-url] +git clone https://code.apps.glenux.net/glenux/igmpgen cd igmpgen ``` ### Build with CMake: -Create a build directory: - -```shell-session -mkdir _build && cd _build -``` - Run CMake and build the project: ```shell-session -cmake .. -cmake --build . +cmake -S . -B _build +cmake --build _build ``` ### Install binaries +Either with your favorite packaging system + ```shell-session -cmake .. -cmake --install . +cpack +``` + +Or directly + +```shell-session +cmake --install _build ``` ## Usage @@ -107,3 +108,8 @@ suggest features, or submit pull requests. This project is licensed under the LGPL 3.0-or-later. +## Related projects + +* [IGMPproxy (Official Version)](https://github.com/pali/igmpproxy): The official version of the IGMPproxy tool. +* [IGMPproxy with IGMPv3 & FreeBSD support](https://github.com/ViToni/igmpproxy/): A version of IGMPproxy with added support for IGMPv3 and FreeBSD. +