summaryrefslogtreecommitdiff
path: root/branding
diff options
context:
space:
mode:
Diffstat (limited to 'branding')
-rw-r--r--branding/README.rst (renamed from branding/README.txt)43
1 files changed, 21 insertions, 22 deletions
diff --git a/branding/README.txt b/branding/README.rst
index c3d9482..86423cc 100644
--- a/branding/README.txt
+++ b/branding/README.rst
@@ -8,21 +8,16 @@ BitmaskVPN for your provider.
Configure
--------------------------------------------------------------------------------
-- Copy or edit the file at 'branding/config/vendor.conf'. Add all the needed variables.
-- Copy your provider CA certificate to the same folder: 'branding/config/<provider>-ca.crt'
-- Make sure that the folder 'branding/assets/<provider>' exists. Copy there all the needed assets.
+* Copy or edit the file at 'branding/config/vendor.conf'. Add all the needed variables.
+* Copy your provider CA certificate to the same folder: 'branding/config/<provider>-ca.crt'
+* Make sure that the folder 'branding/assets/<provider>' exists. Copy there all the needed assets.
Checkout
--------------------------------------------------------------------------------
-git clone https://0xacab.org/leap/bitmask-vpn
-cd bitmask-vpn
-git pull --tags
-
-Build
---------------------------------------------------------------------------------
-
-make build
+ git clone https://0xacab.org/leap/bitmask-vpn
+ cd bitmask-vpn
+ git pull --tags
Package
@@ -32,21 +27,25 @@ NOTE: Some of the following scripts need network access, since they will check
whether the configuration published by your provider matches what is configured
before the build.
-Run:
+Run::
+
+ PROVIDER=example make prepare
+
+You can also specify a custom config file::
-PROVIDER=example make prepare_all
+ PROVIDER=example PROVIDER_CONFIG=/path/to/vendor.conf make prepare
-You can also specify a cusom config file:
+Then you need to build the package::
-PROVIDER=example PROVIDER_CONFIG=/path/to/vendor.conf make prepare_all
-make build
+ make build
-After this, you will find the build scripts ready in the following folder:
+Then you can build all the packages::
-cd build/example
+ make pkg
-make package_win
-make package_osx
-make package_snap
-make package_deb
+Alternatively, you can build only for an specific os::
+ make pkg_win
+ make pkg_osx
+ make pkg_snap
+ make pkg_deb