From 41ba9712ef254b5bfeba4bc051fab41c1aec9d3b Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Tue, 5 Jan 2021 20:40:12 +0100 Subject: [PATCH 1/8] Explain how the new installer can be compiled This will show how to compile the new installer on Windows. Have a look at the discussion in https://github.com/corrados/jamulus/issues/792 --- wiki/en/en-Compiling.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/wiki/en/en-Compiling.md b/wiki/en/en-Compiling.md index ef6e8baeb..5cebeb79e 100644 --- a/wiki/en/en-Compiling.md +++ b/wiki/en/en-Compiling.md @@ -62,13 +62,26 @@ Will build the file and make it available in `./Release/Jamulus.app` ## Windows You don't need to compile Jamulus for Windows since we provide official binaries, but if you really want to, follow the instructions below. -**Required software**: [Qt](https://www.qt.io/download), a compiler like Visual Studio, ASIO development files +**Required software**: [Qt](https://www.qt.io/download), a compiler like Visual Studio ([Build Tools 2017 or 2019](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16) recommended), [ASIO development files](https://www.steinberg.net/en/company/developers.html) -- get the Jamulus source code e.g. via git or via zip download from the Jamulus Repo -- get and copy the [ASIOSDK](https://www.steinberg.net/de/company/developer.html) development files in `[\path\to\jamulus\source]\windows` directory so that, e.g., the - directory `[\path\to\jamulus\source]\ASIOSDK2\common` exists -- open Jamulus.pro in Qt Creator then compile & run +Get the Jamulus source code e.g. via git or [zip download](https://github.com/corrados/jamulus/archive/master.zip) from the [Jamulus repo](https://github.com/corrados/jamulus). Make sure that there are **no** spaces in the directory you move the jamulus directory to since it might break the Jamulus installer (if you know how to fix this issue, please open an issue on the Jamulus repo to tell us how). + +### Compiling and building installer + +Most users will probably want to use this method: +1. Open PowerShell +1. Navigate to the jamulus directory +1. To allow unsigned scripts, run `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser`. You can also revert this after having run this script. For more information see the [Microsoft PowerShell documentation page](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy) +1. Edit the $QtCompile32 and $QtCompile64 variables +1. Run the Jamulus compilation and installer script: `.\windows\deploy_windows.ps1 C:\Qt\QtVersion`. +1. You can now find the Jamulus installer in the `.\deploy` directory + +### Compiling only + +1. Get and copy the [ASIOSDK](https://www.steinberg.net/de/company/developer.html) development files in `[\path\to\jamulus\source]\windows` directory so that, e.g., the + directory `[\path\to\jamulus\source]\ASIOSDK2\common` exists +1. Open Jamulus.pro in Qt Creator then compile & run ## General notes From 7ba59776683d886ffd09e8589e5e1c0338f37b98 Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Tue, 5 Jan 2021 20:51:57 +0100 Subject: [PATCH 2/8] Quote the directory name as code --- wiki/en/en-Compiling.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/wiki/en/en-Compiling.md b/wiki/en/en-Compiling.md index 5cebeb79e..e37e5f6e0 100644 --- a/wiki/en/en-Compiling.md +++ b/wiki/en/en-Compiling.md @@ -64,14 +64,14 @@ You don't need to compile Jamulus for Windows since we provide official binaries **Required software**: [Qt](https://www.qt.io/download), a compiler like Visual Studio ([Build Tools 2017 or 2019](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16) recommended), [ASIO development files](https://www.steinberg.net/en/company/developers.html) -Get the Jamulus source code e.g. via git or [zip download](https://github.com/corrados/jamulus/archive/master.zip) from the [Jamulus repo](https://github.com/corrados/jamulus). Make sure that there are **no** spaces in the directory you move the jamulus directory to since it might break the Jamulus installer (if you know how to fix this issue, please open an issue on the Jamulus repo to tell us how). +Get the Jamulus source code e.g. via git or [zip download](https://github.com/corrados/jamulus/archive/master.zip) from the [Jamulus repo](https://github.com/corrados/jamulus). Make sure that there are **no** spaces in the directory you move the `jamulus` directory to since it might break the Jamulus installer (if you know how to fix this issue, please open an issue on the Jamulus repo to tell us how). ### Compiling and building installer Most users will probably want to use this method: 1. Open PowerShell -1. Navigate to the jamulus directory +1. Navigate to the `jamulus` directory 1. To allow unsigned scripts, run `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser`. You can also revert this after having run this script. For more information see the [Microsoft PowerShell documentation page](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy) 1. Edit the $QtCompile32 and $QtCompile64 variables 1. Run the Jamulus compilation and installer script: `.\windows\deploy_windows.ps1 C:\Qt\QtVersion`. From 08577dd8fb13d1934d9f792f821b9b42c6356d17 Mon Sep 17 00:00:00 2001 From: jdrage Date: Wed, 6 Jan 2021 10:19:43 -0800 Subject: [PATCH 3/8] Add more detail for Windows build process --- wiki/en/en-Compiling.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/wiki/en/en-Compiling.md b/wiki/en/en-Compiling.md index ef6e8baeb..27fceaf7d 100644 --- a/wiki/en/en-Compiling.md +++ b/wiki/en/en-Compiling.md @@ -62,12 +62,21 @@ Will build the file and make it available in `./Release/Jamulus.app` ## Windows You don't need to compile Jamulus for Windows since we provide official binaries, but if you really want to, follow the instructions below. -**Required software**: [Qt](https://www.qt.io/download), a compiler like Visual Studio, ASIO development files +###Required Software +- A compiler like [Visual Studio](https://visualstudio.microsoft.com) +- [Qt](https://www.qt.io/download) +-- Use the free GPLv2 license for Open Source development +-- Select Components during installation - Under **Qt 5.12.3**, add the compiler components for your compiler, e.g., MSVC 2017 32-bit / 64-bit for Visual Studio 2019 +- [ASIO development files](https://www.steinberg.net/de/company/developer.html) -- get the Jamulus source code e.g. via git or via zip download from the Jamulus Repo -- get and copy the [ASIOSDK](https://www.steinberg.net/de/company/developer.html) development files in `[\path\to\jamulus\source]\windows` directory so that, e.g., the - directory `[\path\to\jamulus\source]\ASIOSDK2\common` exists -- open Jamulus.pro in Qt Creator then compile & run +###Setup Steps +1. Get the Jamulus source code e.g. via git or via .zip downloaded from the [Jamulus Repo](https://github.com/corrados/jamulus) + +1. Create a folder under windows called ASIOSDK2 + +1. Download the [ASIOSDK](https://www.steinberg.net/asiosdk), open the top level folder in the .zip file and copy the contents into `[\path\to\jamulus\source]\windows\ASIOSDK2` so that, e.g., the folder `[\path\to\jamulus\source]\windows\ASIOSDK2\common` exists + +1. Open Jamulus.pro in Qt Creator, configure the project with a default kit, then compile & run ## General notes From a393f73f6b68660e42fa1b433093c27bc1eda490 Mon Sep 17 00:00:00 2001 From: jdrage Date: Wed, 6 Jan 2021 10:25:37 -0800 Subject: [PATCH 4/8] Fix formatting --- wiki/en/en-Compiling.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/wiki/en/en-Compiling.md b/wiki/en/en-Compiling.md index 27fceaf7d..a5451fedd 100644 --- a/wiki/en/en-Compiling.md +++ b/wiki/en/en-Compiling.md @@ -62,14 +62,14 @@ Will build the file and make it available in `./Release/Jamulus.app` ## Windows You don't need to compile Jamulus for Windows since we provide official binaries, but if you really want to, follow the instructions below. -###Required Software +### Required Software - A compiler like [Visual Studio](https://visualstudio.microsoft.com) - [Qt](https://www.qt.io/download) --- Use the free GPLv2 license for Open Source development --- Select Components during installation - Under **Qt 5.12.3**, add the compiler components for your compiler, e.g., MSVC 2017 32-bit / 64-bit for Visual Studio 2019 + - Use the free GPLv2 license for Open Source development + - Select Components during installation: Under **Qt 5.12.3**, add the compiler components for your compiler, e.g., MSVC 2017 32-bit / 64-bit for Visual Studio 2019 - [ASIO development files](https://www.steinberg.net/de/company/developer.html) -###Setup Steps +### Setup Steps 1. Get the Jamulus source code e.g. via git or via .zip downloaded from the [Jamulus Repo](https://github.com/corrados/jamulus) 1. Create a folder under windows called ASIOSDK2 From 92c23b13ee80d8c8471058a6d99d7def6cf142a5 Mon Sep 17 00:00:00 2001 From: jdrage Date: Wed, 6 Jan 2021 10:33:12 -0800 Subject: [PATCH 5/8] Add Qt versioning info --- wiki/en/en-Compiling.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/wiki/en/en-Compiling.md b/wiki/en/en-Compiling.md index a5451fedd..60c2c5387 100644 --- a/wiki/en/en-Compiling.md +++ b/wiki/en/en-Compiling.md @@ -66,7 +66,8 @@ You don't need to compile Jamulus for Windows since we provide official binaries - A compiler like [Visual Studio](https://visualstudio.microsoft.com) - [Qt](https://www.qt.io/download) - Use the free GPLv2 license for Open Source development - - Select Components during installation: Under **Qt 5.12.3**, add the compiler components for your compiler, e.g., MSVC 2017 32-bit / 64-bit for Visual Studio 2019 + - To determine the Qt version you need, check [qt-installer-windows.qs](https://github.com/corrados/jamulus/blob/master/windows/qt-installer-windows.qs): under INSTALL_COMPONENTS you will see `qt.qt5.[version]`, e.g., 5123 means version 5.12.3. + - Select Components during installation: Expand the Qt section, find the matching version, e.g., **Qt 5.12.3**, and add the compiler components for your compiler, e.g., `MSVC 2017 32-bit/64-bit` for Visual Studio 2019 - [ASIO development files](https://www.steinberg.net/de/company/developer.html) ### Setup Steps From 40e5ed0ea7d1e42221c608e5dc54744f816989ff Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Wed, 6 Jan 2021 21:12:55 +0100 Subject: [PATCH 6/8] Small edit --- wiki/en/en-Compiling.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wiki/en/en-Compiling.md b/wiki/en/en-Compiling.md index d9103de1b..e3063b251 100644 --- a/wiki/en/en-Compiling.md +++ b/wiki/en/en-Compiling.md @@ -63,7 +63,7 @@ Will build the file and make it available in `./Release/Jamulus.app` You don't need to compile Jamulus for Windows since we provide official binaries, but if you really want to, follow the instructions below. ### Required Software -* A compiler like [Visual Studio](https://visualstudio.microsoft.com) (You only need [Build Tools 2017 or 2019](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16) but can also choose the full IDE from the [Visual Studio download page](https://visualstudio.microsoft.com/downloads/)) +* A compiler like [Visual Studio](https://visualstudio.microsoft.com) (You only need [Build Tools 2017 or 2019](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16) but can also choose to download and install the full IDE from the [Visual Studio download page](https://visualstudio.microsoft.com/downloads/)) * [Qt](https://www.qt.io/download) * Use the free GPLv2 license for Open Source development * To determine the Qt version you need, check [qt-installer-windows.qs](https://github.com/corrados/jamulus/blob/master/windows/qt-installer-windows.qs): under INSTALL_COMPONENTS you will see `qt.qt5.[version]`, e.g., 5123 means version 5.12.3. From 96900015cde606b250655b49ea8bd2aaa073916c Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Mon, 18 Jan 2021 18:41:17 +0100 Subject: [PATCH 7/8] Link quoting issue --- wiki/en/en-Compiling.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wiki/en/en-Compiling.md b/wiki/en/en-Compiling.md index 6cb4b4461..5143232da 100644 --- a/wiki/en/en-Compiling.md +++ b/wiki/en/en-Compiling.md @@ -72,7 +72,7 @@ You don't need to compile Jamulus for Windows since we provide official binaries ### Download Jamulus source code -Get the Jamulus source code e.g. via git or [zip download](https://github.com/corrados/jamulus/archive/master.zip) from the [Jamulus repo](https://github.com/corrados/jamulus). Make sure that there are **no** spaces in the directory you move the `jamulus` directory to since it might break the Jamulus installer (if you know how to fix this issue, please open an issue on the Jamulus repo to tell us how). +Get the Jamulus source code e.g. via git or [zip download](https://github.com/corrados/jamulus/archive/master.zip) from the [Jamulus repo](https://github.com/corrados/jamulus). Make sure that there are **no** spaces in the directory you move the `jamulus` directory to since it might break the Jamulus installer (if you know how to fix this issue, please comment on [issue #864](https://github.com/corrados/jamulus/issues/864) on the Jamulus repo to tell us how). ### Compiling and building installer From 057d6e479722d4e81f4379a1de7e463921eab590 Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Wed, 20 Jan 2021 21:13:16 +0100 Subject: [PATCH 8/8] Review changes --- wiki/en/en-Compiling.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/wiki/en/en-Compiling.md b/wiki/en/en-Compiling.md index 6cb4b4461..4b1704a3f 100644 --- a/wiki/en/en-Compiling.md +++ b/wiki/en/en-Compiling.md @@ -68,7 +68,7 @@ You don't need to compile Jamulus for Windows since we provide official binaries * Use the free GPLv2 license for Open Source development * To determine the Qt version you need, check [qt-installer-windows.qs](https://github.com/corrados/jamulus/blob/master/windows/qt-installer-windows.qs): under INSTALL_COMPONENTS you will see `qt.qt5.[version]`, e.g., 5123 means version 5.12.3. * Select Components during installation: Expand the Qt section, find the matching version, e.g., **Qt 5.12.3**, and add the compiler components for your compiler, e.g., `MSVC 2017 32-bit/64-bit` for Visual Studio 2019 -* [ASIO development files](https://www.steinberg.net/de/company/developer.html) +* [ASIO development files](https://www.steinberg.net/en/company/developer.html) ### Download Jamulus source code @@ -80,10 +80,10 @@ Most users will probably want to use this method: 1. Open PowerShell 1. Navigate to the `jamulus` directory -1. To allow unsigned scripts, run `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser`. You can also revert this after having run this script. For more information see the [Microsoft PowerShell documentation page](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy) -1. Edit the $QtCompile32 and $QtCompile64 variables +1. To allow unsigned scripts, run `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser`. You can also revert this after having run this script. For more information see the [Microsoft PowerShell documentation page](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy). +1. Edit the $QtCompile32 and $QtCompile64 variables. 1. Run the Jamulus compilation and installer script: `.\windows\deploy_windows.ps1 C:\Qt\QtVersion`. -1. You can now find the Jamulus installer in the `.\deploy` directory +1. You can now find the Jamulus installer in the `.\deploy` directory. ### Compiling only