summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKali Kaneko (leap communications) <kali@leap.se>2016-10-04 02:21:32 -0400
committerKali Kaneko (leap communications) <kali@leap.se>2016-10-04 02:21:32 -0400
commitff3ed1e9418eab21fd42bb5ddd96a3851a25801c (patch)
treedb8fa73481327694ddd7bfaf2107c337b2321e53
parent330771b4a98ac969794c9e5c1f061bfee9484ca8 (diff)
[docs] fix readme markup
-rw-r--r--README.rst33
-rw-r--r--docs/hacking/index.rst10
2 files changed, 21 insertions, 22 deletions
diff --git a/README.rst b/README.rst
index 3f501c6..79e4cfc 100644
--- a/README.rst
+++ b/README.rst
@@ -88,17 +88,20 @@ commands for you.
Install headless backend in development mode
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-Prerequisites:
+Prerequisites::
sudo apt install build-essential python-virtualenv libsqlcipher-dev \
libssl-dev libffi-dev
+
+Install and activate a virtualenv::
+
cd bitmask-dev
virtualenv venv
source venv/bin/activate
All the subsequent commands assume that you have activated the virtualenv.
-Install python dependencies:
+Install all the python dependencies::
make dev-backend
@@ -107,16 +110,16 @@ Install user interface frontend
If you want to run the Bitmask user interface, you additionally need the following:
-Prerequisites:
+Prerequisites::
sudo apt install python-pyqt5 python-pyqt5.qtwebkit
-Install python dependencies:
+Install python dependencies::
make dev-all
-Note: even though the UI is in javascript, Qt is used to create a webview
-window.
+Note: even though the UI is in javascript, Qt is used to create a webview window.
+
Install Bitmask user interface in development mode
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -127,28 +130,18 @@ bundled version of the javascript UI.
If you want to modify the javascript UI, then you need to be able to update the
javascript bundle whenever a javascript or CSS source file changes.
-Prerequisites:
+Prerequisites::
sudo apt install nodejs npm nodejs-legacy
-Next, run ``dev-install``:
+Next, run ``dev-install``::
cd ui
- make dev-install # install JS user interface as a python package in "develop" mode.
- node run watch # continually rebuild javascript bundle when source files change.
+ make dev-install # install JS user interface as a python package in "develop" mode.
+ node run watch # continually rebuild javascript bundle when source files change.
For more information, see ``ui/README.md``.
-Cross-testing
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-
-If you are developing against a non-published branch of ``leap.common`` or
-``leap.soledad``, run instead::
-
- tox -e py27-dev
-
-This expects ``leap_common`` and ``soledad`` repos to be checked out in the
-parent folder.
License
diff --git a/docs/hacking/index.rst b/docs/hacking/index.rst
index f1991af..2a48a7b 100644
--- a/docs/hacking/index.rst
+++ b/docs/hacking/index.rst
@@ -15,16 +15,22 @@ Tox is all you need::
Test when changes are made to common/soledad
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you modify soledad or leap.common packages::
+
+If you are developing against a non-published branch of ``leap.common`` or
+``leap.soledad``, run instead::
tox -e py27-dev
+This expects ``leap_common`` and ``soledad`` repos to be checked out in the
+parent folder.
+
Setting up the development environment
--------------------------------------
Dependencies::
- apt install ...
+ sudo apt install build-essential python-virtualenv libsqlcipher-dev \
+ libssl-dev libffi-dev
There are different requirements files::