Add a README

1 files changed, 35 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..462c692
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# SlackBuilder
+
+SlackBuilder is a tool which aims to help to update Slackware packages.
+It checks for the latest version of an upstream package and can modify
+SlackBuild meta information accordingly.
+
+## Build instructions
+
+SlackBuilder is a Haskell program and can be built and run using the
+Cabal build tool and package manager:
+
+```sh
+cabal build
+```
+
+After that you can run slackbuilder using Cabal and `cabal run slackbuilder`.
+Or you can install the program locally with `cabal install` and run it just
+as `slackbuilder` assuming `~/.cabal/bin` is on your PATH.
+
+## Configuration
+
+There is a sample configuration file under `config/config.toml.example`.
+Just copy this file to `config/config.toml` and modify as needed.
+
+Each package that should be updated automatically needs a special
+description which contains links to the upstream repositories and
+instructions how the sources should be prepared.
+
+Unfortunately the only format currently supported for the package
+descriptions is Haskell source code. But I'm planning to make it
+possible to describe the packages without recompiling the slackbuilder
+itself.
+
+For the time being `src/Main.hs` contains descriptions of my
+slackbuilds, that can be used as an example and a start point.