summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 14 insertions, 9 deletions
diff --git a/README.md b/README.md
index a6f8839..280b975 100644
--- a/README.md
+++ b/README.md
@@ -50,24 +50,29 @@ They are expected and don't produce any problem on the systray.
Run it
-------------
-bitmask-systray assumes that you already have bitmaskd running.
+The default build is a standalone systray. It still requires a helper and openvpn installed to work. For linux the helper is
+[bitmask-root](https://0xacab.org/leap/bitmask-dev/blob/master/src/leap/bitmask/vpn/helpers/linux/bitmask-root)
+for windows and OSX there is [a helper written in go](https://0xacab.org/leap/riseup_vpn/tree/master/helper).
-Run bitmask and the systray:
+To build and run it:
```
- $ bitmaskd
+ $ go build
$ ./bitmask-systray
```
-Standalone
+
+Bitmaskd
-------------
+Is also posible to compile the systray to use bitmask as backend:
+```
+ $ go build -tags bitmaskd
+```
-Is also posible to compile the systray to be standalone (don't depend on bitmask):
+In that case bitmask-systray assumes that you already have bitmaskd running. Run bitmask and the systray:
```
- $ go build -tags standalone
+ $ bitmaskd
+ $ ./bitmask-systray
```
-It still requires a helper and openvpn installed to work. For linux the helper is
-[bitmask-root](https://0xacab.org/leap/bitmask-dev/blob/master/src/leap/bitmask/vpn/helpers/linux/bitmask-root)
-for windows and OSX there is [a helper written in go](https://0xacab.org/leap/riseup_vpn/tree/master/helper).
i18n