From 690cf7a9ce3f7b5ae7912500518ab37755fee29f Mon Sep 17 00:00:00 2001 From: elijah Date: Fri, 7 Oct 2016 13:59:15 -0700 Subject: [doc] ui - update readme to be more clear --- README.rst | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 56ac0d6f..8fae7fd0 100644 --- a/README.rst +++ b/README.rst @@ -91,8 +91,8 @@ Run headless backend in development mode Prerequisites:: - sudo apt install build-essential python-virtualenv libsqlcipher-dev \ - libssl-dev libffi-dev + sudo apt install build-essential python-dev python-virtualenv \ + libsqlcipher-dev libssl-dev libffi-dev Install and activate a virtualenv:: @@ -151,12 +151,10 @@ Next, run ``dev-install``:: cd ui make dev-install # install JS code as a python package in "develop" mode. - node run watch # continually rebuild JS bundle when source files change. -For more information, see ``ui/README.md``. - -Run user interface with debugging tools:: +Now you should be able to run the user interface with debugging tools:: + bitmaskd chromium-browser http://localhost:7070 Firefox does not work as well, because the UI is only tested with webkit-based @@ -166,8 +164,17 @@ Chromium is not the best for this, however, because it uses a newer webkit. Instead, try qupzilla:: sudo apt install qupzilla + bitmaskd qupzilla -ow http://localhost:7070 +If you make a change to any of the CSS or JS source files, you need to rebuild +the javascript bundle. You can do this continually as files change like so: + + cd ui + node run watch + +For more information, see ``ui/README.md``. + License =========================================================== -- cgit v1.2.3