1 files changed, 51 insertions, 0 deletions
diff --git a/branding/README.rst b/branding/README.rst
new file mode 100644
index 0000000..86423cc
--- /dev/null
+++ b/branding/README.rst
@@ -0,0 +1,51 @@
+Branding for BitmaskVPN
+================================================================================
+
+This folder contains everything that is needed to generate a customized built of
+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.
+
+Checkout
+--------------------------------------------------------------------------------
+
+ git clone https://0xacab.org/leap/bitmask-vpn
+ cd bitmask-vpn
+ git pull --tags
+
+
+Package
+--------------------------------------------------------------------------------
+
+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::
+
+ PROVIDER=example make prepare
+
+You can also specify a custom config file::
+
+ PROVIDER=example PROVIDER_CONFIG=/path/to/vendor.conf make prepare
+
+Then you need to build the package::
+
+ make build
+
+Then you can build all the packages::
+
+ make pkg
+
+Alternatively, you can build only for an specific os::
+
+ make pkg_win
+ make pkg_osx
+ make pkg_snap
+ make pkg_deb