summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md47
-rw-r--r--doc/BUILD-FROM-GIT.md75
2 files changed, 42 insertions, 80 deletions
diff --git a/README.md b/README.md
index c3dad20..d44ea1d 100644
--- a/README.md
+++ b/README.md
@@ -12,14 +12,45 @@ complementary functionality. Libnet is very handy with which to write
network tools and network test code. See the manpage and sample test
code for more detailed information.
+Online documentation is available at https://codedocs.xyz/libnet/libnet/
+
> **NOTE:** Legacy code written for *libnet-1.0.x* WILL NOT WORK with
-> *libnet-1.1.x*. Read *doc/MIGRATION* for porting legacy code.
+> *libnet-1.1.x* or later. See [MIGRATION](doc/MIGRATION) for porting
+> legacy code.
+
+
+Building
+--------
+
+Libnet employs the GNU configure and build system. 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).
+On Debian/Ubuntu systems:
+
+ sudo apt install autoconf automake libtool
-**LIBNET 1.1 (c) 1998 - 2004 Mike D. Schiffman <mike@infonexus.com>**
-http://www.packetfactory.net/libnet
+To build the documentation (optional) you need doxygen and pod2man:
-**LIBNET 1.1.3 and later (c) 2009 - 2013 Sam Roberts <vieuxtech@gmail.com>**
-http://github.com/sam-github/libnet
+ sudo apt install doxygen pod2man
+
+For neat graphics in the HTML documentation, also install graphviz.
+There is also a PDF version of the docs, to build that you need quite a
+few more packages:
+
+ sudo apt install texlive-extra-utils texlive-latex-extra \
+ texlive-fonts-recommended latex-xcolor \
+ texlive-font-utils
+
+Fior Microsoft CHM docs you need the HTML Help Workshop, which is part
+of Visual Studio: http://go.microsoft.com/fwlink/p/?linkid=154968, on
+UNIX and GNU/Linux systems, see `chmcmd`, which is available in the
+[FreePascal](http://www.freepascal.org/) suite:
+
+ sudo apt install fp-utils-3.0.4
Origin & References
@@ -38,6 +69,12 @@ Some old docs are available at:
http://packetfactory.openwall.net/projects/libnet/index.html
+-------------------------------------------------------------------------
+- v1.1 (c) 1998 - 2004 Mike D. Schiffman <mike@infonexus.com>
+ http://www.packetfactory.net/libnet
+- v1.1.3 and later (c) 2009 - 2013 Sam Roberts <vieuxtech@gmail.com>
+ http://github.com/libnet/libnet
+-------------------------------------------------------------------------
[Appveyor]: https://ci.appveyor.com/project/troglobit/libnet
[Appveyor Status]: https://ci.appveyor.com/api/projects/status/fkw05hw8cysfl2p1?svg=true
diff --git a/doc/BUILD-FROM-GIT.md b/doc/BUILD-FROM-GIT.md
deleted file mode 100644
index 690d0c6..0000000
--- a/doc/BUILD-FROM-GIT.md
+++ /dev/null
@@ -1,75 +0,0 @@
-# BUILD FROM GIT #
-
-I build from git using some top-level scripts. Refer to libnet/INSTALL for additional information and libnet/README.win32 if you're building for/on Windows.
-
-## Minimum requirements are: ##
-
-- A C compiler (obviously)
-
-The Autotools:
-- autoconf 2.69
-- automake 1.14
-- libtool 2.4.2
-
-
-## To build the documentation (optional): ##
-
-- doxygen 1.8.14
-- pod2man
-
-**...and optionally:**
-
-**For Graphics:**
-- graphviz
-
-**For PDF/PS:**
-(The tools found in) The doxygen-latex Package:
-
-- texlive-extra-utils,
-- texlive-latex-extra,
-- texlive-fonts-recommended,
-- latex-xcolor,
-- texlive-font-utils,
-- ghostscript
-
-**For CHM:**
-On Windows:
-- Microsoft HTML Help Workshop (Part of Visual Studio)
-Standalone: http://go.microsoft.com/fwlink/p/?linkid=154968
-
-On *nix:
-- chmcmd (Part of the Free Pascal Compiler (http://www.freepascal.org/)
-
-
-## To build LUA bindings (optional): ##
-
-- libdumbnet-dev
-(consider using my fork https://github.com/sgeto/libdnet)
-
-- liblua5.1-0-dev (See lua/Makefile)
-
-## **To create Debian packages:** ##
-
-- debhelper
-- sharutils
-- quilt
-
-## General procedure is: ##
-
-`git clone https://github.com/sgeto/libnet.git`
-
-`cd libnet/libnet`
-
-`../Prepare`
-
-`../Build`
-
-and then, one of the following, depending on how you like to install local packages:
-
-`sudo make install`
-
-`../Stow`
-
-`../Package`
-
-**Again, see libnet/INSTALL and libnet/README.win32 for more detailed instructions.**