summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2015-05-29 19:15:45 +0100
committerCarl Hetherington <cth@carlh.net>2015-05-29 19:15:45 +0100
commit856bf40f586665549c7b890b9f5c1b3240daa145 (patch)
treea9ab3057885ff25d01a6fedcddb17c08f0ef4e00
parent2070358ea52d238028dd4e6d98d0bd6c58d69932 (diff)
Use markdown for README.
-rw-r--r--README.md (renamed from README)23
1 files changed, 13 insertions, 10 deletions
diff --git a/README b/README.md
index deb4b528..b8bcc3f3 100644
--- a/README
+++ b/README.md
@@ -1,24 +1,26 @@
-== libdcp
+libdcp
+======
Hello.
-== Acknowledgements
+Acknowledgements
+================
Wolfgang Woehl's cinemaslides was most informative on the
nasty details of encryption.
+Building
+========
+ ./waf configure
+ ./waf
+ sudo ./waf install
-== Building:
-./waf configure
-./waf
-./waf install
-
-
-== Dependencies
+Dependencies
+============
boost filesystem, signals2 and unit testing libraries
openssl
@@ -28,7 +30,8 @@ xmlsec
openjpeg (1.5.0 or above)
-== Documentation
+Documentation
+=============
Run doxygen in the top-level directory and then see build/doc/html/index.html.