summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2015-06-01 15:50:55 +0100
committerCarl Hetherington <cth@carlh.net>2015-06-01 15:50:55 +0100
commit7b25f67df7480e28a8aff33a7078c674150d6f00 (patch)
treeca216caa5719e38b31ec2e9b8841e1a2adf3c002 /README.md
parent099e93f617e3cfc8cd371d652c2d2ed040f94e7b (diff)
parent856bf40f586665549c7b890b9f5c1b3240daa145 (diff)
Merge branch 'master' of git.carlh.net:git/libdcp
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..b8bcc3f3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+libdcp
+======
+
+Hello.
+
+
+Acknowledgements
+================
+
+Wolfgang Woehl's cinemaslides was most informative on the
+nasty details of encryption.
+
+
+Building
+========
+
+ ./waf configure
+ ./waf
+ sudo ./waf install
+
+
+Dependencies
+============
+
+boost filesystem, signals2 and unit testing libraries
+openssl
+libsigc++
+libxml++
+xmlsec
+openjpeg (1.5.0 or above)
+
+
+Documentation
+=============
+
+Run doxygen in the top-level directory and then see build/doc/html/index.html.
+
+There are some examples in the examples/ directory.