summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorkali kaneko (leap communications) <kali@leap.se>2020-10-02 20:28:46 +0200
committerkali kaneko (leap communications) <kali@leap.se>2020-10-02 20:33:41 +0200
commit8c0ced091ce1122dec5f1d414e094f7129c9b846 (patch)
treeb9e574d311d78eef9c1022908635931f452cf591 /README.md
parent1501c0319f226eb25cf98e194a24233852638c62 (diff)
[test] include missing qrc
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 12 insertions, 21 deletions
diff --git a/README.md b/README.md
index f4f16e9..bcb6f28 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,17 @@
-Install it
-----------
+Build
+-----
Install dependencies:
-TODO: add qt5 deps here
-
```
- # make depends
+ sudo make depends
```
-Build the systray:
+Build the application:
+
```
- $ git clone 0xacab.org/leap/bitmask-vpn && cd bitmask-vpn
- $ make build
+ git clone 0xacab.org/leap/bitmask-vpn && cd bitmask-vpn
+ make build
```
You need at least go 1.11. If you have something older and are using ubuntu, you can do:
@@ -29,19 +28,11 @@ OSX
Using homebrew:
```
- $ git clone 0xacab.org/leap/bitmask-vpn && cd bitmask-vpn
- $ make depends
- $ make build
-
-```
-
-Linux
-----------
-
-```
+ git clone 0xacab.org/leap/bitmask-vpn && cd bitmask-vpn
+ make depends
make build
-```
+```
Running tests
-------------
@@ -64,13 +55,13 @@ https://www.transifex.com/otf/bitmask/RiseupVPN/
When a string has being modified you need to regenerate the locales:
```
- $ make generate_locales
+ make generate_locales
```
To fetch the translations from transifex and rebuild the catalog.go (API\_TOKEN is the transifex API token):
```
- $ API_TOKEN='xxxxxxxxxxx' make locales
+ API_TOKEN='xxxxxxxxxxx' make locales
```
There is some bug on gotext and the catalog.go generated doesn't have a package, you will need to edit
cmd/bitmask-vpn/catalog.go and to have a `package main` at the beginning of the file.