summaryrefslogtreecommitdiff
path: root/branding/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'branding/README.txt')
-rw-r--r--branding/README.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/branding/README.txt b/branding/README.txt
new file mode 100644
index 0000000..3601524
--- /dev/null
+++ b/branding/README.txt
@@ -0,0 +1,21 @@
+Branding for BitmaskVPN
+================================================================================
+
+This folder contains everything that is needed to generate a customized built of
+BitmaskVPN for your provider.
+
+
+Configure
+--------------------------------------------------------------------------------
+
+- Edit the file at 'branding/config/vendor.conf'. Add all the needed variables.
+- Copy your provider CA certificate to 'branding/config/<provider>-ca.crt'
+- Make sure that the folder 'branding/assets/<provider>' exists. Copy there all the needed assets.
+
+Build
+--------------------------------------------------------------------------------
+
+Run:
+
+PROVIDER=example.org make generate
+make build