doc: update content
Some checks failed
continuous-integration/drone/push Build is failing

This commit is contained in:
Glenn Y. Rolland 2023-12-26 15:17:55 +01:00
parent 981514377a
commit 5452136d68

View file

@ -2,8 +2,8 @@
## Overview ## Overview
The IGMP Packet Generator is a specialized tool designed for generating various The IGMP Packet Generator (`igmpgen`) is a specialized tool designed for
types of Internet Group Management Protocol (IGMP) packets. generating various types of Internet Group Management Protocol (IGMP) packets.
This tool is particularly useful for network administrators, developers, and This tool is particularly useful for network administrators, developers, and
researchers involved in testing and analyzing multicast network protocols. 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: For debian/ubuntu, simply type:
```shell-session ```shell-session
sudo apt-get install cmake libnet1-dev sudo apt-get install cmake libnet1-dev gcc rpm
``` ```
## Install ## Install
@ -35,30 +35,31 @@ sudo apt-get install cmake libnet1-dev
### Clone the Repository (if applicable): ### Clone the Repository (if applicable):
```bash ```bash
git clone [repository-url] git clone https://code.apps.glenux.net/glenux/igmpgen
cd igmpgen cd igmpgen
``` ```
### Build with CMake: ### Build with CMake:
Create a build directory:
```shell-session
mkdir _build && cd _build
```
Run CMake and build the project: Run CMake and build the project:
```shell-session ```shell-session
cmake .. cmake -S . -B _build
cmake --build . cmake --build _build
``` ```
### Install binaries ### Install binaries
Either with your favorite packaging system
```shell-session ```shell-session
cmake .. cpack
cmake --install . ```
Or directly
```shell-session
cmake --install _build
``` ```
## Usage ## Usage
@ -107,3 +108,8 @@ suggest features, or submit pull requests.
This project is licensed under the LGPL 3.0-or-later. 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.