From 593a8f178bb0d931d265e233a8f598414d038c1b Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Sun, 5 Jul 2015 14:29:54 +0200 Subject: update documentation --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) (limited to 'README.md') 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 ` or start a systemd unit with +`systemctl start dyndhcpd@`. -- cgit v1.2.3-54-g00ecf