summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoachim Nilsson <troglobit@gmail.com>2019-10-06 09:05:58 +0200
committerJoachim Nilsson <troglobit@gmail.com>2019-10-06 09:05:58 +0200
commit7adc89d6cf351dc7a40a92bb56e67cad52286518 (patch)
tree04b7244c2e1023fa0b35ebd6b1a87745f1d91f1d
parentfb70e8f73363876bf3aac0d8749d7758a689a847 (diff)
downloadlibnet-7adc89d6cf351dc7a40a92bb56e67cad52286518.tar.gz
Divide Building in sub-sections to help reader find relevant info
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
-rw-r--r--README.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/README.md b/README.md
index 09f35af..6ccd016 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
[![Appveyor Status][]][Appveyor] [![Travis Status][]][Travis] [![CodeDocs Status][]][CodeDocs]
-A C library for portable packet creation and injection
-======================================================
+Portable Packet Construction and Injection
+==========================================
-Libnet is an API to help with the construction and handling of network
+Libnet is an API to help with the construction and injection of network
packets. It provides a portable framework for low-level network packet
writing and handling (use libnet in conjunction with libpcap and you can
write some really cool stuff). Libnet includes packet creation at the
@@ -38,13 +38,17 @@ Libnet employs the [GNU configure and build system][autotools]. The
release tarballs ship with a pre-built `configure` script. To list
available options, type <kbd>./configure --help</kbd>
-When checking out the code from GitHub, use <kbd>./autogen.sh</kbd> to
-generate a `configure` script. For this you need the full suite of the
-GNU autotools: autoconf (>=2.69), automake (>=1.14), libtool (>=2.4.2).
+### Building from GIT/GitHub
+
+When building from GIT, use <kbd>./autogen.sh</kbd> to generate the
+`configure` script. For this you need the full suite of the GNU
+autotools: autoconf (>=2.69), automake (>=1.14), libtool (>=2.4.2).
On Debian/Ubuntu systems:
sudo apt install autoconf automake libtool
+### Building the Documentation
+
To build the documentation (optional) you need doxygen and pod2man:
sudo apt install doxygen pod2man