Skip to content
Snippets Groups Projects
Unverified Commit 1678e257 authored by Kali Kaneko's avatar Kali Kaneko
Browse files

[docs] add some TODOs in the README

parent 4faad2cd
No related branches found
No related tags found
No related merge requests found
......@@ -2,6 +2,9 @@ Install it
----------
Install dependencies:
TODO: add qt5 deps here
```
# make depends
```
......@@ -34,49 +37,15 @@ Using homebrew:
Linux
----------
Building the systray in linux will produce some `-Wdeprecated-declarations` warnings, like that:
```
cgo-gcc-prolog: In function ‘_cgo_3f9f61f961c9_Cfunc_gtk_font_button_get_font_name’:
cgo-gcc-prolog:5455:2: warning: ‘gtk_font_button_get_font_name’ is deprecated [-Wdeprecated-declarations]
In file included from /usr/include/gtk-3.0/gtk/gtk.h:106:0,
from ../../../go/src/github.com/gotk3/gotk3/gtk/gtk.go:48:
/usr/include/gtk-3.0/gtk/gtkfontbutton.h:96:23: note: declared here
const gchar * gtk_font_button_get_font_name (GtkFontButton *font_button);
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
```
They are expected and don't produce any problem on the systray.
Run it
-------------
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/bitmask-vpn/tree/master/pkg/helper/).
To build and run it:
```
$ make build
$ build/bin/bitmask-vpn
```
Bitmaskd
-------------
Is also posible to compile the systray to use bitmask as backend:
```
$ go build -tags bitmaskd
```
In that case bitmask-systray assumes that you already have bitmaskd running. Run bitmask and the systray:
```
$ bitmaskd
$ build/bin/bitmask-vpn
```
./build.sh
i18n
----
TODO: move this to developer docs
The translations are done in transifex. To help us contribute your translations there and/or review the existing
ones:
https://www.transifex.com/otf/bitmask/RiseupVPN/
......@@ -86,6 +55,7 @@ When a string has being modified you need to regenerate the 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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment