Update README, now in markdown format. Add OSX.

diff --git a/README b/README.md
similarity index 62%
rename from README
rename to README.md
index 0d1f2bc032f21b596bd03270a3f390854a790627..8cfe61109b6f043c52be659d388668c7c9bbe6b0 100644 (file)
--- a/README
+++ b/README.md
@@ -1,4 +1,5 @@
-PowerDNS is copyright 2012 by PowerDNS.COM BV & lots of contributors 
+PowerDNS is copyright Ⓒ 2012-2013 by PowerDNS.COM BV & lots of
+contributors, using the GNU GPLv2 license.
 
 This file may lag behind at times. For most recent updates, always check
 http://doc.powerdns.com/changelog.html and http://wiki.powerdns.com
@@ -7,27 +8,24 @@ Another good place to look for information is:
 http://doc.powerdns.com/compiling-powerdns.html
 
 To file bugs, head towards:
+https://github.com/PowerDNS/pdns/issues
 
-       https://github.com/PowerDNS/pdns/issues
-
-but first check existing ones:
-
-       https://github.com/PowerDNS/pdns/issues
+But please check if the issue is already reported there first.
 
 COMPILING
 ---------
 PowerDNS 3.0 and beyond depend on Lua and Boost. To get these libraries,
-install the relevant packages. On Debian and Ubunty, try:
+install the relevant packages. On Debian and Ubuntu, try:
 
-# apt-get install g++ libboost-program-options-dev
-  libboost-serialization-dev libpqclient-dev libmysqlclient-dev
-  libsqlite3-dev libpq-dev
+    # apt-get install g++ libboost-program-options-dev \
+      libboost-serialization-dev libpqclient-dev libmysqlclient-dev \
+      libsqlite3-dev libpq-dev
 
 To compile a very clean version, use:
 
-$ ./configure --with-modules="" 
-$ make
-# make install
+    $ ./configure --with-modules=""
+    $ make
+    # make install
 
 This generates a PowerDNS binary with no modules, except the bind backend,
 built in, and the pipe-backend available for runtime loading.
@@ -37,16 +35,19 @@ built-in by default and the pipe-backend is compiled for runtime loading.
 
 To add multiple modules, try:
 
-$ ./configure --with-modules="gmysql gpgsql"
+    $ ./configure --with-modules="gmysql gpgsql"
 
 See http://rtfm.powerdns.com/compiling-powerdns.html for more details.
 
 Please don't use the 'mysql' backend, it is deprecated. Use the 'gmysql'
-one! 
+one!
+
+SOURCE CODE / GIT
+-----------------
+
+Source code is available on GitHub:
 
-SUBVERSION / CVS
-----------------
-If you need code from SVN read HACKING
+    $ git clone https://github.com/PowerDNS/pdns.git
 
 SOLARIS NOTES
 -------------
@@ -66,13 +67,33 @@ appears to work, but doesn't in fact. Use gmake, not make.
 pipebackend does not work due to bad interaction between fork and pthreads.
 Amazingly, running the Linux version under the linuxulator DOES work!
 
+MAC OS X NOTES
+--------------
+
+PowerDNS is available through Homebrew:
+
+    $ brew install pdns
+
+If you want to compile yourself, the dependencies can be installed using
+Homebrew:
+
+    $ brew install boost lua ragel
+
+For PostgreSQL support:
+
+    $ brew install postgresql
+
+For MySQL support:
+
+    $ brew install mariadb
+
 LINUX NOTES
 -----------
 None really.
 
 WIN32 NOTES
 -----------
-See http://rtfm.powerdns.com/compiling-powerdns.html#ON-WINDOWS 
+See http://rtfm.powerdns.com/compiling-powerdns.html#ON-WINDOWS
 
 Needs Visual C++