Dominik Deák
4 years ago
parent
0a8be30f23
commit
2a31c13cdf
9 changed files with 149 additions and 144 deletions
@ -1,28 +0,0 @@ |
||||
## Building on macOS |
||||
|
||||
### Prerequisites |
||||
|
||||
1. Install the following tools and dependencies: |
||||
|
||||
* [Homebrew](http://brew.sh/) |
||||
* [XCode](https://developer.apple.com/xcode/download/) |
||||
* [Qt 5](https://www.qt.io/download), select the following components: |
||||
* Qt 5.12.9 / macOS |
||||
|
||||
<!-- /Users/dom/Qt5.12.9/5.12.9/clang_64 --> |
||||
|
||||
|
||||
2. Use Homebrew to install additional tools and libraries: |
||||
|
||||
```sh |
||||
brew install cmake libsodium openssl |
||||
``` |
||||
|
||||
### Compiling (Easy Mode) |
||||
|
||||
Run the command script `buildMacOS.sh --all` to build all packages. For other options, run with the `--help` switch. |
||||
|
||||
<!-- ### Compiling (Hard Mode) |
||||
|
||||
Alternatively, you can opt to build the binaries only, as detailed below. We're assuming the current path is in the `Synergy-Binaries` project root. |
||||
--> |
||||
@ -1,55 +0,0 @@ |
||||
## Building on Linux Mint / Ubuntu |
||||
|
||||
### Prerequisites |
||||
|
||||
Install the following tools and dependencies: |
||||
|
||||
```sh |
||||
sudo apt-get install \ |
||||
cmake g++ libavahi-compat-libdnssd-dev \ |
||||
libcurl4-openssl-dev libegl1-mesa \ |
||||
libgl1-mesa-glx libqt5svg5-dev libsodium-dev \ |
||||
libssl-dev libsystemd-dev libx11-dev \ |
||||
make qtbase5-dev qtcreator qtdeclarative5-dev \ |
||||
qttools5-dev xorg-dev |
||||
``` |
||||
|
||||
For building Debian packages: |
||||
|
||||
```sh |
||||
sudo apt-get install build-essential devscripts dh-make lintian |
||||
``` |
||||
|
||||
### Compiling (Easy Mode) |
||||
|
||||
Run the shell script `buildLinux.sh --all` to build all packages. For other options, run with the `--help` switch. |
||||
|
||||
### Compiling (Hard Mode) |
||||
|
||||
Alternatively, you can opt to build the binaries only, as detailed below. We're assuming the current path is in the `Synergy-Binaries` project root. |
||||
|
||||
```sh |
||||
cd Synergy-Core |
||||
mkdir build |
||||
cd build |
||||
|
||||
cmake .. -D CMAKE_BUILD_TYPE=MINSIZEREL -D SYNERGY_ENTERPRISE=ON |
||||
|
||||
cmake --build . --parallel 8 |
||||
``` |
||||
|
||||
Optional, install the application: |
||||
|
||||
```sh |
||||
sudo cmake --install . |
||||
``` |
||||
|
||||
### Launching Automatically |
||||
|
||||
In Linux Mint we can launch `synergy` client automatically via _System Settings → Startup Applications_, then add an entry with the command: |
||||
|
||||
```sh |
||||
/usr/bin/synergyc --name ClientName --daemon #.#.#.# |
||||
``` |
||||
|
||||
Substitute the `ClientName` with the local machine name, and the Synergy server IP `#.#.#.#` with whatever appropriate for your set-up. |
||||
@ -1,45 +0,0 @@ |
||||
## Building on Windows |
||||
|
||||
### Prerequisites |
||||
|
||||
1. Install the following tools and dependencies: |
||||
|
||||
* [Git for Windows](https://gitforwindows.org/) |
||||
* [CMake](https://cmake.org/) |
||||
* [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/), select the following components: |
||||
* VS 2019 C++ x64/x86 build tools |
||||
* Windows 10 SDK |
||||
* [WiX Toolset](https://wixtoolset.org/releases/), install the following components: |
||||
* WiX Toolset Build Tools |
||||
* WiX Toolset Visual Studio 2019 Extension |
||||
* [Qt 5](https://www.qt.io/download), select the following components: |
||||
* Qt 5.12.9 / MSVC 2017 64-bit |
||||
|
||||
2. Edit the `buildWindows.cmd` script and make sure the following script variables are configured properly: |
||||
|
||||
* `libQtPath` - Path to the Qt library, Visual C++, 64-bit build. |
||||
|
||||
* `vcvarsallCommand` - Path to Visual Studio's `vcvarsall.bat` command script, which sets compiler environment variables. See [Microsoft C++ toolset documentation](https://docs.microsoft.com/en-us/cpp/build/building-on-the-command-line?view=vs-2019) for details. |
||||
|
||||
* `cmakeGenerator` - Specifies the "generator" setting for cmake. Run `cmake --help` to choose the suitable generator for your current tool chain. |
||||
|
||||
### Compiling (Easy Mode) |
||||
|
||||
Run the command script `buildWindows.cmd --all` to build all packages. For other options, run with the `--help` switch. |
||||
|
||||
### Compiling (Hard Mode) |
||||
|
||||
Alternatively, you can opt to build the binaries only, as detailed below. We're assuming the current path is in the `Synergy-Binaries` project root. |
||||
|
||||
```bat |
||||
cd Synergy-Core |
||||
mkdir build |
||||
cd build |
||||
|
||||
call "c:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvarsall.bat" x64 |
||||
|
||||
cmake .. -G "Visual Studio 16 2019" -D CMAKE_PREFIX_PATH="c:\Qt\Qt5.12.9\5.12.9\msvc2017_64" -D CMAKE_BUILD_TYPE=MINSIZEREL -D SYNERGY_ENTERPRISE=ON |
||||
|
||||
msbuild synergy-core.sln /p:Platform="x64" /p:Configuration=Release /m |
||||
``` |
||||
You may need to use different paths to `vcvarsall.bat` and Qt libraries, whatever is appropriate for your system. Consequently, the generator `-G` switch for `cmake` must also reflect the tool chain environment. See `cmake --help` for details. |
||||
@ -0,0 +1,42 @@ |
||||
## Building on macOS |
||||
|
||||
### Prerequisites |
||||
|
||||
1. Install the following tools and dependencies: |
||||
|
||||
* [Homebrew](http://brew.sh/) |
||||
* [Python 3](https://www.python.org/downloads/windows/) |
||||
* [XCode](https://developer.apple.com/xcode/download/) |
||||
* [Qt 5](https://www.qt.io/download/), select the following components: |
||||
* Qt 5.12.9 / macOS |
||||
|
||||
2. Edit the [`Scripts\config.txt`](../Scripts/config.txt) file and make sure the following variables are configured properly under the `[Darwin]` section: |
||||
|
||||
* `libQtPath` -- Full path to the Qt library, clang, 64-bit build. |
||||
|
||||
3. Run the installer script to configure additional dependencies, as noted below. If you wish to examine what packages will be installed, see package lists [`PackageListBrew.txt`](../Scripts/Install/PackageListBrew.txt) and [`PackageListPython.txt`](../Scripts/Install/PackageListPython.txt). |
||||
|
||||
* If Python is already installed: |
||||
```sh |
||||
python.exe ./Scripts/install.py [--upgrade] |
||||
``` |
||||
* If Python is not installed: |
||||
```sh |
||||
./Scripts/Install/InstallDarwin.sh [--upgrade] |
||||
``` |
||||
|
||||
Use the `--upgrade` switch to refresh packages at a later date. |
||||
|
||||
### Building |
||||
|
||||
Build the project with the following Python script. Packages will be copied into the [`Binaries`](../Binaries) directory. |
||||
|
||||
```sh |
||||
./Scripts/build.py |
||||
``` |
||||
|
||||
Similarly, one can clean the project, which resets Git repositories to a clean state: |
||||
|
||||
```sh |
||||
./Scripts/clean.py |
||||
``` |
||||
@ -0,0 +1,45 @@ |
||||
## Building on Linux Mint / Ubuntu |
||||
|
||||
### Prerequisites |
||||
|
||||
1. Install Python 3: |
||||
```sh |
||||
sudo apt-get install python3 python3-pip python3-setuptools |
||||
``` |
||||
|
||||
2. Run the installer script to configure additional dependencies, as noted below. If you wish to examine what packages will be installed, see package lists [`PackageListAPT.txt`](../Scripts/Install/PackageListAPT.txt) and [`PackageListPython.txt`](../Scripts/Install/PackageListPython.txt). |
||||
|
||||
* If Python is already installed: |
||||
```sh |
||||
python.exe ./Scripts/install.py [--upgrade] |
||||
``` |
||||
* If Python is not installed: |
||||
```sh |
||||
./Scripts/Install/InstallLinux.sh [--upgrade] |
||||
``` |
||||
|
||||
Use the `--upgrade` switch to refresh packages at a later date. |
||||
|
||||
### Building |
||||
|
||||
Build the project with the following Python script. Packages will be copied into the [`Binaries`](../Binaries) directory. |
||||
|
||||
```sh |
||||
./Scripts/build.py |
||||
``` |
||||
|
||||
Similarly, one can clean the project, which resets Git repositories to a clean state: |
||||
|
||||
```sh |
||||
./Scripts/clean.py |
||||
``` |
||||
|
||||
### Launching Automatically |
||||
|
||||
In Linux Mint we can launch `synergy` client automatically via _System Settings → Startup Applications_, then add an entry with the command: |
||||
|
||||
```sh |
||||
/usr/bin/synergyc --name ClientName --daemon #.#.#.# |
||||
``` |
||||
|
||||
Substitute the `ClientName` with the local machine name, and the Synergy server IP `#.#.#.#` with whatever appropriate for your set-up. |
||||
@ -0,0 +1,49 @@ |
||||
## Building on Windows |
||||
|
||||
### Prerequisites |
||||
|
||||
1. Install the following tools and dependencies: |
||||
|
||||
* [Chocolatey](https://chocolatey.org/) |
||||
* [Python 3](https://www.python.org/downloads/windows/) |
||||
* [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/), select the following components: |
||||
* VS 2019 C++ x64/x86 build tools |
||||
* Windows 10 SDK |
||||
* [WiX Toolset](https://wixtoolset.org/releases/), install the following components: |
||||
* WiX Toolset Build Tools |
||||
* WiX Toolset Visual Studio 2019 Extension |
||||
* [Qt 5](https://www.qt.io/download/), select the following components: |
||||
* Qt 5.12.9 / MSVC 2017 64-bit |
||||
|
||||
2. Edit the [`Scripts\config.txt`](../Scripts/config.txt) file and make sure the following variables are configured properly under the `[Windows]` section: |
||||
|
||||
* `libQtPath` -- Full path to the Qt library, Visual C++, 64-bit build. |
||||
* `vcvarsallPath` -- Full path to Visual Studio's `vcvarsall.bat` command script. which sets compiler environment variables. See [Microsoft C++ toolset documentation](https://docs.microsoft.com/en-us/cpp/build/building-on-the-command-line?view=vs-2019) for details. |
||||
* `cmakeGenerator` -- Specifies the generator setting for cmake. Run `cmake --help` to choose a suitable generator that best matches the Visual Studio version installed earlier. |
||||
|
||||
3. Run the installer script to configure additional dependencies, as noted below. If you wish to examine what packages will be installed, see package lists [`PackageListChoco.config`](../Scripts/Install/PackageListChoco.config) and [`PackageListPython.txt`](../Scripts/Install/PackageListPython.txt). |
||||
|
||||
* If Python is already installed: |
||||
```bat |
||||
python.exe Scripts\install.py [--upgrade] |
||||
``` |
||||
* If Python is not installed: |
||||
```bat |
||||
powershell.exe -File Scripts\Install\InstallWindows.ps1 [-upgrade] |
||||
``` |
||||
|
||||
Use the `--upgrade` switch (or `-upgrade` switch for PowerShell) to refresh packages at a later date. |
||||
|
||||
### Building |
||||
|
||||
Build the project with the following Python script. Packages will be copied into the [`Binaries`](../Binaries) directory. |
||||
|
||||
```bat |
||||
python.exe Scripts\build.py |
||||
``` |
||||
|
||||
Similarly, one can clean the project, which resets Git repositories to a clean state: |
||||
|
||||
```bat |
||||
python.exe Scripts\clean.py |
||||
``` |
||||
Loading…
Reference in new issue