summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKali Kaneko (leap communications) <kali@leap.se>2016-09-01 01:05:46 -0400
committerKali Kaneko (leap communications) <kali@leap.se>2016-09-01 01:05:46 -0400
commitc5a3ad66c44267e2e8906f472251db82279d287f (patch)
tree974c3ce6dafc46569cbd74f9d73269e32229faf1
parent12ac5fba0e05b05bcfbfa6dde61168048550376a (diff)
[docs] add basic info about development
-rw-r--r--README.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index e69de29..80dbb67 100644
--- a/README.rst
+++ b/README.rst
@@ -0,0 +1,24 @@
+bitmask-dev
+===========
+Your internet encryption toolkit.
+
+Develop
+-------
+
+If you want to develop for the encrypted mail service, execute inside your virtualenv::
+
+ make dev-mail
+
+If you want to develop for the gui client::
+
+ make dev-all
+
+Tests
+-----
+
+Tests need tox::
+
+ pip install tox
+ tox
+
+