From 677a502c13bd5733ffb7f0951d71f96dfaeba169 Mon Sep 17 00:00:00 2001
From: William Brown <william@blackhats.net.au>
Date: Jan 31 2018 02:31:26 +0000
Subject: Ticket 49554 - update readme


Bug Description:  Our readme needs improving.

Fix Description:  Improve it with build steps and links, change
to md format.

https://pagure.io/389-ds-base/issue/49554

Author: wibrown

Review by: mreynolds, vashirov (Thanks!)

---

diff --git a/README b/README
deleted file mode 100644
index 19d2c36..0000000
--- a/README
+++ /dev/null
@@ -1,12 +0,0 @@
-======================================================================= 
-                       389 Directory Server
-=======================================================================
-
-The 389 Directory Server is subject to the terms detailed in the
-license agreement file called LICENSE.
-
-Late-breaking news and information on the 389 Directory Server is
-available on our wiki page:
-
-    http://www.port389.org/
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0d6de4f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+389 Directory Server
+====================
+
+389 Directory Server is a highly usable, fully featured, reliable
+and secure LDAP server implementation. It handles many of the
+largest LDAP deployments in the world.
+
+All our code has been extensively tested with sanitisation tools.
+As well as a rich feature set of fail-over and backup technologies
+gives administrators confidence their accounts are safe.
+
+License
+-------
+
+The 389 Directory Server is subject to the terms detailed in the
+license agreement file called LICENSE.
+
+Late-breaking news and information on the 389 Directory Server is
+available on our wiki page:
+
+    http://www.port389.org/
+
+Building
+--------
+
+    autoreconf -fiv
+    ./configure --enable-debug --with-openldap --enable-cmocka --enable-asan
+    make
+    make lib389
+    make check
+    sudo make install
+    sudo make lib389-install
+
+Testing
+-------
+
+    sudo py.test -s 389-ds-base/dirsrvtests/tests/suites/basic/
+
+More information
+----------------
+
+Please see our contributing guide online:
+
+    http://www.port389.org/docs/389ds/contributing.html
+