summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authordrebs <drebs@leap.se>2013-04-09 13:56:22 -0300
committerdrebs <drebs@leap.se>2013-04-09 13:56:22 -0300
commit3e0d12b8130a317c11da5145bb878b70b3bd8cac (patch)
tree6492fb450b57ee1e911b3efb0f563b9547405061 /README
parenta8adbad77d34c66eda2a79e19b9afbc0f3d471a6 (diff)
Add check for presence of a shared db.
Diffstat (limited to 'README')
-rw-r--r--README43
1 files changed, 9 insertions, 34 deletions
diff --git a/README b/README
index 923f2d7a..c03b766b 100644
--- a/README
+++ b/README
@@ -6,44 +6,19 @@ This software is under development.
Dependencies
------------
-Soledad depends on the following python libraries:
+The following Soledad dependencies have not been packaged in pypi yet, and so
+are downloaded directly from their repositories (see `setup.py`):
- * u1db 0.1.4 [1]
- * python-gnupg 0.3.1 [2]
- * CouchDB 0.8 [3]
- * hmac 20101005 [4]
- * pysqlcipher [5]
-
-[1] http://pypi.python.org/pypi/u1db/0.1.4
-[2] http://pypi.python.org/pypi/python-gnupg/0.3.1
-[3] http://pypi.python.org/pypi/CouchDB/0.8
-[4] http://pypi.python.org/pypi/hmac/20101005
-[5] Instructions for downloading and installing are below.
-
-pysqlcipher
------------
-
-Pysqlcipher is an experimental fork of pysqlite, and is statically linked
-against sqlcipher.
-
-To install it, do the following:
-
- git clone git://git.futeisha.org/pysqlcipher.git
- cd pysqlcipher
- python setup.py install
+ * pysqlcipher: pysqlite fork that binds to SQLCipher libraries.
+ Repository: git://git.futeisha.org/pysqlcipher.git@develop
+ * leap.common: Leap's common code (provides config, events, testing, etc).
+ Repository: ssh://code.leap.se/leap_pycommon.git@develop
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 CouchDB installed in the system.
- 3. Have pysqlcipher module properly installed as described above.
-
-Soledad's tests should be run with nose2, like this:
-
- nose2 leap.soledad.tests
+To run CouchDB tests, be sure you have CouchDB installed on your system.
+Tests can be run with:
+ python setup.py test