summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDaniil Baturin <daniil@baturin.org>2018-11-29 00:19:38 +0100
committerDaniil Baturin <daniil@baturin.org>2018-11-29 00:19:38 +0100
commitbb95c51b82f2a7b97ab4050fff014b2a4787a0bd (patch)
treeaa77dae88462e96598dd9c1d976f7d430d5df6c2 /README.md
parentac1cef3952640d1ff289890cb9fc8a55b175ff73 (diff)
downloadipaddrcheck-bb95c51b82f2a7b97ab4050fff014b2a4787a0bd.tar.gz
ipaddrcheck-bb95c51b82f2a7b97ab4050fff014b2a4787a0bd.zip
Add building and testing instructions.
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 17a4ec5..ed242a5 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
ipaddrcheck
===========
+## Using
+
An IPv4 and IPv6 validation utility for use in scripts
Depends on libcidr by Matthew Fuller (http://www.over-yonder.net/~fullermd/projects/libcidr) and libpcre.
@@ -44,3 +46,18 @@ Depends on libcidr by Matthew Fuller (http://www.over-yonder.net/~fullermd/proje
1 if check failed,
2 if a problem occured (wrong option, internal error etc.)
+## Building
+
+Building from source:
+
+```
+autoreconf -i
+./configure
+make && make install
+```
+
+Running unit tests:
+
+```
+make check
+```