summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoachim Nilsson <troglobit@gmail.com>2019-09-28 16:26:43 +0200
committerJoachim Nilsson <troglobit@gmail.com>2019-09-28 16:26:43 +0200
commit72fd03c1cdcb88c5279f31222b3167575add3d15 (patch)
treee90a9353dcce8a03c7864831f549e7b1340a404a /doc
parente4fb7e9a1ac7b1695235519ac81bfda616776504 (diff)
downloadlibnet-72fd03c1cdcb88c5279f31222b3167575add3d15.tar.gz
Relocate some docs to doc/
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/BUILD-FROM-GIT.md75
-rw-r--r--doc/RELEASE-CHECKLIST.txt35
2 files changed, 110 insertions, 0 deletions
diff --git a/doc/BUILD-FROM-GIT.md b/doc/BUILD-FROM-GIT.md
new file mode 100644
index 0000000..690d0c6
--- /dev/null
+++ b/doc/BUILD-FROM-GIT.md
@@ -0,0 +1,75 @@
+# 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.**
diff --git a/doc/RELEASE-CHECKLIST.txt b/doc/RELEASE-CHECKLIST.txt
new file mode 100644
index 0000000..80f7a46
--- /dev/null
+++ b/doc/RELEASE-CHECKLIST.txt
@@ -0,0 +1,35 @@
+Release Checklist
+=================
+
+Pre-release:
+
+- doc/CHANGELOG
+
+Use ../ChangeLog to update changelog.
+
+- README.txt, libnet/README
+
+Sync these.
+
+- configure.ac
+
+Update version.
+
+- src/Makefile.am
+
+Update LDFLAGS' version-info.
+
+- tag it, with -rc#
+
+> git tag -a libnet-x.y.z -m libnet-x.y.z
+> git push --tags
+
+- Build it, ../Build
+
+- Push it, ../Push
+
+- Announce release-candidate on libnet-dev-announce and to people in doc/CONTRIB
+
+
+- Announce release on libnet-dev-announce
+