From 7aa96cb396a84cf7a2818a23efb7f80d82a6fbbe Mon Sep 17 00:00:00 2001
From: "kali kaneko (leap communications)" <kali@leap.se>
Date: Fri, 16 Oct 2020 02:17:09 +0200
Subject: [PATCH] [pkg] rename to make-installer

---
 Makefile               |  2 +-
 README.md              | 39 ++++++++++-----------------------------
 docs/branding.rst      |  6 +++---
 docs/build.windows.rst |  4 ++--
 docs/i18n-howto.rst    | 21 +++++++++++++++++++++
 5 files changed, 37 insertions(+), 35 deletions(-)
 create mode 100644 docs/i18n-howto.rst

diff --git a/Makefile b/Makefile
index 4d0ff327..ff351bc5 100644
--- a/Makefile
+++ b/Makefile
@@ -103,7 +103,7 @@ build_helper:
 build_openvpn:
 	@[ -f $(OPENVPN_BIN) ] && echo "OpenVPN already built at" $(OPENVPN_BIN) || ./branding/thirdparty/openvpn/build_openvpn.sh
 
-build_installer: check_qtifw build
+installer: check_qtifw build
 	@mkdir -p ${INST_DATA}
 	@cp -r ${TEMPLATES}/qtinstaller/packages ${INSTALLER}
 	@cp -r ${TEMPLATES}/qtinstaller/installer.pro ${INSTALLER}
diff --git a/README.md b/README.md
index bcb6f285..699a14e0 100644
--- a/README.md
+++ b/README.md
@@ -24,18 +24,18 @@ For other situations, have a look at https://github.com/golang/go/wiki/Ubuntu or
 
 
 OSX
-----------
-Using homebrew:
+---
+
+You can install dependencies with homebrew:
 
 ```
   git clone 0xacab.org/leap/bitmask-vpn && cd bitmask-vpn
   make depends
   make build
-
 ```
 
-Running tests
--------------
+Test
+----
 
 ```
   sudo apt install qml-module-qttest
@@ -44,33 +44,14 @@ Running tests
 ```
 
 
-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/
-
-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
-```
-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.
+Translations
+------------
 
-If you want to add a new language create the folder `locales/$lang` before running `make locales`.
+We use [transifex](https://www.transifex.com/otf/bitmask/RiseupVPN/) to coordinate translations. Any help is welcome!
 
 
-Report an issue
--------------------
+Bugs?
+-----
 
 When you report an issue include the following information:
 
diff --git a/docs/branding.rst b/docs/branding.rst
index 6c7a0d91..80ca7486 100644
--- a/docs/branding.rst
+++ b/docs/branding.rst
@@ -53,11 +53,11 @@ Then you can build the binaries for some quick manual testing::
 
 Now you can build the installer for your host platform::
 
- make build_installer
+ make installer
 
 Previously we had a cross-compilation setup in place. Cross compilation will be added back in the future.
 
 For debian and snap packages (FIXME -- WORK IN PROGRESS):
 
-  make debian
-  make snap
+  make package_debian
+  make package_snap
diff --git a/docs/build.windows.rst b/docs/build.windows.rst
index 818f813f..27edcbce 100644
--- a/docs/build.windows.rst
+++ b/docs/build.windows.rst
@@ -13,5 +13,5 @@ For the installer, install QtIFW for windows (tested with version 3.2.2).
 Assuming you have the vendor path in place and correctly configured, all you need to do is `make build_installer`::
 
   export PATH="/c/Qt/Qt5/bin/":"/c/Qt/QtIFW-3.2.2/bin":$PATH
-  VENDOR_PATH=providers/
-  make build_installer
+  export VENDOR_PATH=providers
+  make vendor && make installer
diff --git a/docs/i18n-howto.rst b/docs/i18n-howto.rst
new file mode 100644
index 00000000..337c2e63
--- /dev/null
+++ b/docs/i18n-howto.rst
@@ -0,0 +1,21 @@
+Howto i18n
+----------
+
+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/
+
+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
+```
+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.
+
+If you want to add a new language create the folder `locales/$lang` before running `make locales`.
-- 
GitLab