use Data.Default.Class for empty NmcDom
[pdns-pipe-nmc.git] / README.md
index 3780aec274d33fe91aefd253ee2bd297340568c1..bbb361c7bd6e9bdd66fc23969c1b5a53c3b409d6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,16 +15,23 @@ frontend, and has simple backend interface.
 
 ## Building
 
-The program is built as a single executable to be run by PowerDns's
-pipe backend. It is written in [Haskell](http://www.haskell.org/).
-There is no `cabal` configuration at the moment, so to build it,
-simply run
+The program is a single executable to be run by PowerDns's pipe
+backend. It is written in [Haskell](http://www.haskell.org/).
+If you have haskell installed on your system, run
 
 ```
-ghc --make pdns-pipe-nmc
+cabal configure
 ```
 
-and install any missing packages it complains about.
+followed by
+
+```
+cabal build
+```
+
+and hopefully it will tell you what packages are missing. You can
+install them either with your OS package manager (if they exist in
+your distribution) or with `cabal install`.
 
 ## Installing
 
@@ -83,8 +90,9 @@ your resolvers.
 ## Status
 
 Beta. It is mostly feature-complete, but insufficiently tested.
-It implements the data format specification (SPEC.md in the source
-distribution) that slightly deviates from the
+It implements the
+[data format specification](http://www.average.org/pdns-pipe-nmc/spec.html)
+(SPEC.md in the source distribution) that slightly deviates from the
 [official specification](https://wiki.namecoin.info/index.php?title=Domain_Name_Specification).
 I am using it to access some of the `.bit` websites and it works
 for me.