added Readme and updated manpage

1 files changed, 58 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..b387555
--- /dev/null
+++ b/README
@@ -0,0 +1,58 @@
+Introduction
+============
+
+dropnroll is a small daemon which can be used to watch one or more
+directories for new files. When a new file is detected an external program will
+get started.
+Additional directories can be added to the daemon's watch list using a simple
+unix socket based command interface.
+
+Dependencies
+============
+
+Linux
+-----
+
+core:
+ build-essential
+
+if you want to rebuild the manpage:
+ asciidoc
+
+
+Installation
+============
+
+Getting the source via GIT:
+---------------------------
+
+git clone git://git.spreadspace.org/dropnroll.git
+cd dropnroll
+
+
+Building from source
+--------------------
+
+# cd src
+# ./configure
+# make
+
+
+Installing
+----------
+
+# sudo make install
+
+This will install dropnroll under the --prefix defined with configure.
+
+
+Uninstalling
+------------
+
+# sudo make remove
+
+This removes everything except for the config files
+
+# sudo make purge
+
+This also removes the config files