summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorTobias Klauser <tklauser@distanz.ch>2016-09-12 17:09:19 +0200
committerTobias Klauser <tklauser@distanz.ch>2016-09-12 17:20:12 +0200
commitab55a68c191bb720dc8e37b9a41248761e7f5cad (patch)
tree4a3034686c56121dcbb84bc5ab294bc0bc631fc0 /README
parent0abe253f93ea00ae455667b8ab7fe3d5d19a1e8a (diff)
README: Convert to markdown
Convert the README file to markdown syntax so we get the nice rendering on GitHub. Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
Diffstat (limited to 'README')
-rw-r--r--README76
1 files changed, 0 insertions, 76 deletions
diff --git a/README b/README
deleted file mode 100644
index 58e27ca..0000000
--- a/README
+++ /dev/null
@@ -1,76 +0,0 @@
-llmnrd - Link-Local Multicast Resolution Daemon
-===============================================
-
-llmnrd is a daemon implementing the Link-Local Multicast Name Resolution (LLMNR)
-protocol according to RFC 4795. It currently only supports Linux, as it uses the
-netlink kernel interface.
-
-llmnrd will respond to name resolution queries sent by Windows clients in
-networks where no DNS server is available. It supports both IPv4 and IPv6.
-
-Installation
-------------
-
-To build and install llmnrd use the following commands:
-
- $ make
- $ sudo make install
-
-By default, the llmnrd binary will be installed to /usr/local/sbin. To install
-the binary to a different installation path, use:
-
- $ make
- $ sudo make prefix=<path> install
-
-Cross-Compilation
------------------
-
-To cross-compile llmnrd for a different architecture, use the CROSS_COMPILE make
-variable. To e.g. build it using the arm-linux-gnueabihf toolchain use:
-
- $ make CROSS_COMPILE=arm-linux-gnueabihf-
-
-When cross-compiling, you usually don't want to install the generated binary to
-your root filesystem, but to the sysroot of a cross-compiled system. Use the
-DESTDIR variable to change the installation destination path, e.g.
-
- $ make DESTDIR=$HOME/sysroot/ prefix=/usr install
-
-License
--------
-
-llmnrd is free software: you can redistribute it and/or modify it under the
-terms of the GNU General Public License as published by the Free Software
-Foundation, version 2 of the License.
-
-llmnrd is distributed in the hope that it will be useful, but WITHOUT ANY
-WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
-PARTICULAR PURPOSE. See the GNU General Public License for more details.
-
-Authors
--------
-
-llmnrd is authored and maintained by Tobias Klauser <tklauser@distanz.ch>
-
-The following people contributed patches and ideas, found and reported bugs or
-otherwise helped in the development of llmnrd:
-
-* Martin Hauke
-* Michael Evertz (@dvl-mevertz)
-* Schimmelreiter (@Schimmelreiter)
-* SviMik (@svimik)
-
-Thanks a lot!
-
-References
-----------
-
-RFC 4795
- https://tools.ietf.org/html/rfc4795
-
-Microsoft TechNet article about LLMNR
- https://technet.microsoft.com/en-us/library/bb878128.aspx
-
-xllmnrd: An IPv6-only LLMNR responder daemon
- http://www.vx68k.org/xllmnrd
- https://bitbucket.org/kazssym/xllmnrd/