summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2015-07-05 14:29:54 +0200
committerGravatar Christian Hesse <mail@eworm.de>2015-07-05 14:29:54 +0200
commit593a8f178bb0d931d265e233a8f598414d038c1b (patch)
tree5bf3bd8f437ba0f2e71c973ab09e0f09c713022b
parenta76cf581dde260fabd803465dc413648d419dcf7 (diff)
downloaddyndhcpd-593a8f178bb0d931d265e233a8f598414d038c1b.tar.gz
dyndhcpd-593a8f178bb0d931d265e233a8f598414d038c1b.tar.zst
update documentation
-rw-r--r--README.md33
1 files changed, 32 insertions, 1 deletions
diff --git a/README.md b/README.md
index 49e9126..3190d99 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,35 @@
dyndhcpd
========
-start DHCP daemon that dynamically creates configuration based on assigned IP address
+start DHCP daemon that dynamically creates configuration based on
+assigned IP address
+
+Requirements
+------------
+
+To compile and run `dyndhcpd` you need:
+
+* [ISC DHCPD](https://www.isc.org/software/dhcp)
+* [markdown](http://daringfireball.net/projects/markdown/) (HTML documentation)
+
+Build and install
+-----------------
+
+Building and installing is very easy. Just run:
+
+> make
+
+followed by:
+
+> make install
+
+This will place an executable at `/usr/bin/dyndhcpd`, template configuration
+will go to `/etc/dyndhcpd/`, documentation can be found in
+`/usr/share/doc/dyndhcpd/`. Additionally a systemd unit file is installed to
+`/usr/lib/systemd/system/dyndhcpd@.service`.
+
+Usage
+-----
+
+Just run `dyndhcpd -i <interface>` or start a systemd unit with
+`systemctl start dyndhcpd@<interface>`.