1 files changed, 37 insertions, 0 deletions
diff --git a/src/leap/soledad/README b/src/leap/soledad/README
new file mode 100644
index 00000000..3bf62494
--- /dev/null
+++ b/src/leap/soledad/README
@@ -0,0 +1,37 @@
+Soledad -- Synchronization Of Locally Encrypted Data Among Devices
+==================================================================
+
+This software is under development.
+
+Dependencies
+------------
+
+Soledad depends on the following python libraries:
+
+  * u1db 0.1.4 [1]
+  * python-swiftclient 1.2.0 [2]
+  * python-gnupg 0.3.1 [3]
+  * CouchDB 0.8 [4]
+  * hmac 20101005 [5]
+
+[1] http://pypi.python.org/pypi/u1db/0.1.4
+[2] http://pypi.python.org/pypi/python-swiftclient/1.2.0
+[3] http://pypi.python.org/pypi/python-gnupg/0.3.1
+[4] http://pypi.python.org/pypi/CouchDB/0.8
+[5] http://pypi.python.org/pypi/hmac/20101005
+
+
+Tests
+-----
+
+Soledad's tests should be run with nose2, like this:
+
+  nose2 leap.soledad.tests
+
+Right now, there are 3 conditions that have to be met for all Soledad tests to
+pass without problems:
+
+  1. Use nose2.
+  2. Have an http CouchDB instance running on `localhost:5984`.
+  3. Have sqlcipher configured (using LD_PRELOAD or LD_LIBRARY_CONFIG to point
+     to the place where libsqlite3.so.0 is located).