summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKali Kaneko (leap communications) <kali@leap.se>2017-05-22 14:05:53 +0200
committerKali Kaneko (leap communications) <kali@leap.se>2017-05-22 14:05:53 +0200
commitb2c8da69f7a06a4bdfe5c632931bf913c5110583 (patch)
treeb8f4bd824b585e73e60fee08624d4b9a23f698a6
parent96462b1798f4269c4162df1e20e2f4da6dacc8e8 (diff)
[docs] add e2e and ui tests to readme
-rw-r--r--README.rst20
1 files changed, 15 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 1e71651e..b8626689 100644
--- a/README.rst
+++ b/README.rst
@@ -40,16 +40,17 @@ isolated, under the leap namespace:
bonafide, mail, keymanager, bitmask.
-The previous Qt client has been deprecated (bitmask version 0.9.2, still
-available at the http://github.com/leapcode/bitmask_client repo).
+The previous client using PySide has been deprecated (bitmask version 0.9.2,
+still available at the http://github.com/leapcode/bitmask_client repo).
Read the Docs!
-----------------------------------------------------------
-The latest documentation about Bitmask is available at `LEAP`_.
+There is documentation about Bitmask `for users`_ and `for developers`_.
-.. _`LEAP`: https://leap.se/en/docs/client
+.. _`for users`: https://leap.se/en/docs/client
+.. _`for developers`: https://bitmask.rtfd.io
Bugs
===========================================================
@@ -83,10 +84,19 @@ You need tox to run the tests. If you don't have it in your system yet::
pip install tox
-And then run all the tests::
+And then run all the python tests::
tox
+There are some minimal end-to-end tests::
+
+ make test_e2e
+
+For testing the UI (aka ``bitmask-js``) you need to have ``mocha``
+installed. You can run ui tests like this::
+
+ cd ui && make test
+
Hacking
-----------------------------------------------------------