Skip to content

Commit 00a50a7

Browse files
pinhead84pinhead84
committed
update documentation
1 parent 0967a55 commit 00a50a7

9 files changed

Lines changed: 72 additions & 30 deletions

‎doc‎

Submodule doc updated from ccdc62f to bbf3ddc

‎release/.env.example‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@
44
# Copy this file to ".env" and enter your environment variables.
55
#
66

7+
# Bundle name for Staff tool in generated bundles.
8+
STAFF_TOOL="StaffSupportTool"
9+
10+
# Name for Customer tool in generated bundles.
11+
CUSTOMER_TOOL="CustomerSupportTool"
12+
13+
# Version number used in generated bundles.
14+
VERSION="1.1.2"
15+
716
# In order to sign the application for yourself, you need to obtain a Developer ID from Apple and set the
817
# name of your signature key in the APPLE_CODESIGN_KEY variable.
918
APPLE_CODESIGN_KEY=""

‎release/bundle-linux.sh‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,29 @@
1616
# limitations under the License.
1717
#
1818

19-
STAFF_TOOL="StaffSupportTool"
20-
CUSTOMER_TOOL="CustomerSupportTool"
21-
VERSION="1.1.2"
19+
# ----------------------------------------------------------------------------
20+
# NOTICE: This script requires an ".env" file in the same folder. If it is not
21+
# available, create a copy of ".env.example" and place your settings inside.
22+
# ----------------------------------------------------------------------------
23+
24+
# ----------------------------------------------------------------------------
25+
# You can find further information at:
26+
# https://github.com/OpenIndex/RemoteSupportTool/wiki/Development#create-application-bundles
27+
# ----------------------------------------------------------------------------
2228

2329
MAKESELF="makeself"
2430
DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
2531
TARGET_DIR="${DIR}/target"
2632
FOUND="0"
2733
set -e
2834

35+
STAFF_TOOL=""
36+
CUSTOMER_TOOL=""
37+
VERSION=""
38+
if [[ -f "${DIR}/.env" ]]; then
39+
source "${DIR}/.env"
40+
fi
41+
2942
if [[ -d "${TARGET_DIR}/Staff/linux-x86" ]]; then
3043
FOUND="1"
3144
echo ""

‎release/bundle-macos.sh‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,29 @@
1616
# limitations under the License.
1717
#
1818

19-
STAFF_TOOL="StaffSupportTool"
20-
CUSTOMER_TOOL="CustomerSupportTool"
21-
VERSION="1.1.2"
19+
# ----------------------------------------------------------------------------
20+
# NOTICE: This script requires an ".env" file in the same folder. If it is not
21+
# available, create a copy of ".env.example" and place your settings inside.
22+
# ----------------------------------------------------------------------------
23+
24+
# ----------------------------------------------------------------------------
25+
# You can find further information at:
26+
# https://github.com/OpenIndex/RemoteSupportTool/wiki/Development#create-application-bundles
27+
# ----------------------------------------------------------------------------
2228

2329
MAKESELF="makeself"
2430
DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
2531
TARGET_DIR="${DIR}/target"
2632
FOUND="0"
2733
set -e
2834

35+
STAFF_TOOL=""
36+
CUSTOMER_TOOL=""
37+
VERSION=""
38+
if [[ -f "${DIR}/.env" ]]; then
39+
source "${DIR}/.env"
40+
fi
41+
2942
if [[ -d "${TARGET_DIR}/Staff/macos-x86-64" ]]; then
3043
FOUND="1"
3144
echo ""

‎release/bundle-windows.sh‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,15 @@
1616
# limitations under the License.
1717
#
1818

19-
STAFF_TOOL="StaffSupportTool"
20-
CUSTOMER_TOOL="CustomerSupportTool"
21-
VERSION="1.1.2"
19+
# ----------------------------------------------------------------------------
20+
# NOTICE: This script requires an ".env" file in the same folder. If it is not
21+
# available, create a copy of ".env.example" and place your settings inside.
22+
# ----------------------------------------------------------------------------
23+
24+
# ----------------------------------------------------------------------------
25+
# You can find further information at:
26+
# https://github.com/OpenIndex/RemoteSupportTool/wiki/Development#create-application-bundles
27+
# ----------------------------------------------------------------------------
2228

2329
WINE="$(which "wine")"
2430
WINEPATH="$(which "winepath")"
@@ -30,6 +36,13 @@ TARGET_DIR="${DIR}/target"
3036
FOUND="0"
3137
set -e
3238

39+
STAFF_TOOL=""
40+
CUSTOMER_TOOL=""
41+
VERSION=""
42+
if [[ -f "${DIR}/.env" ]]; then
43+
source "${DIR}/.env"
44+
fi
45+
3346
CUSTOMER_SFX="${DIR}/src/windows/7zSD.sfx"
3447
STAFF_SFX="${DIR}/src/windows/7zSD.sfx"
3548
if [[ -x "${WINE}" ]]; then

‎release/codesign-macos.sh‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,12 @@
2121
# required certificate available. In order to sign the application for
2222
# yourself, you need to obtain a Developer ID from Apple and set some
2323
# environment variables in the ".env" file. If it is not available, create a
24-
# copy from ".env.example".
24+
# copy of ".env.example".
25+
# ----------------------------------------------------------------------------
26+
27+
# ----------------------------------------------------------------------------
28+
# You can find further information at:
29+
# https://github.com/OpenIndex/RemoteSupportTool/wiki/Development#sign-application-bundle-for-macos
2530
# ----------------------------------------------------------------------------
2631

2732
DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)

‎release/notarize-macos-finish.sh‎

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,8 @@
1717
#
1818

1919
# ----------------------------------------------------------------------------
20-
# NOTICE: This script has to be executed on a macOS system with the
21-
# required certificate available. In order to sign the application for
22-
# yourself, you need to obtain a Developer ID from Apple and set some
23-
# environment variables in the ".env" file. If it is not available, create a
24-
# copy from ".env.example".
25-
# ----------------------------------------------------------------------------
26-
27-
# ----------------------------------------------------------------------------
28-
# Further information about notarization:
29-
# https://successfulsoftware.net/2018/11/16/how-to-notarize-your-software-on-macos/
30-
# https://developer.apple.com/documentation/xcode/notarizing_macos_software_before_distribution/customizing_the_notarization_workflow
20+
# You can find further information at:
21+
# https://github.com/OpenIndex/RemoteSupportTool/wiki/Development#notarizing-application-bundle-for-macos
3122
# ----------------------------------------------------------------------------
3223

3324
DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)

‎release/notarize-macos-upload.sh‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,12 @@
2121
# required certificate available. In order to sign the application for
2222
# yourself, you need to obtain a Developer ID from Apple and set some
2323
# environment variables in the ".env" file. If it is not available, create a
24-
# copy from ".env.example".
24+
# copy of ".env.example".
2525
# ----------------------------------------------------------------------------
2626

2727
# ----------------------------------------------------------------------------
28-
# Further information about notarization:
29-
# https://successfulsoftware.net/2018/11/16/how-to-notarize-your-software-on-macos/
30-
# https://developer.apple.com/documentation/xcode/notarizing_macos_software_before_distribution/customizing_the_notarization_workflow
28+
# You can find further information at:
29+
# https://github.com/OpenIndex/RemoteSupportTool/wiki/Development#notarizing-application-bundle-for-macos
3130
# ----------------------------------------------------------------------------
3231

3332
DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)

‎release/notarize-macos-verify.sh‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,12 @@
2121
# required certificate available. In order to sign the application for
2222
# yourself, you need to obtain a Developer ID from Apple and set some
2323
# environment variables in the ".env" file. If it is not available, create a
24-
# copy from ".env.example".
24+
# copy of ".env.example".
2525
# ----------------------------------------------------------------------------
2626

2727
# ----------------------------------------------------------------------------
28-
# Further information about notarization:
29-
# https://successfulsoftware.net/2018/11/16/how-to-notarize-your-software-on-macos/
30-
# https://developer.apple.com/documentation/xcode/notarizing_macos_software_before_distribution/customizing_the_notarization_workflow
28+
# You can find further information at:
29+
# https://github.com/OpenIndex/RemoteSupportTool/wiki/Development#notarizing-application-bundle-for-macos
3130
# ----------------------------------------------------------------------------
3231

3332
DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)

0 commit comments

Comments
 (0)