4d84097334
* Forward port: Change default value for dev thanks message * Remove sneaky submodules * Update ChangeLog
105 lines
3.3 KiB
Markdown
105 lines
3.3 KiB
Markdown
# Synergy
|
|
|
|
[](https://sonarcloud.io/summary/new_code?id=symless_synergy)
|
|
[](https://github.com/symless/synergy/actions/workflows/ci.yml)
|
|
[](https://github.com/symless/synergy/actions/workflows/codeql-analysis.yml)
|
|
[](https://github.com/symless/synergy/actions/workflows/sonarcloud-analysis.yml)
|
|
[](https://github.com/symless/synergy/actions/workflows/build-containers.yml)
|
|
|
|
[Synergy](https://symless.com/synergy) is a keyboard and mouse sharing app. Use the keyboard, mouse, or trackpad of one computer to control nearby computers, and work seamlessly between them.
|
|
|
|
This project contains the source code for _Synergy 1 Community Edition_ which is actively maintained, free to use, and does not require a license or serial key.
|
|
|
|
**Wayland support:** Wayland is supported (GNOME 46 is required).
|
|
|
|
|
|
|
|
To use the community edition, install the `synergy` package with your favorite package manager or build it yourself using the Developer Quick Start instructions below.
|
|
|
|
Join us on [Discord](https://discord.com/invite/xBFv6j7) or [Slack](https://synergy-app.slack.com/join/shared_invite/zt-d8if26fr-6x~TSTz4skGmTnFP5IPaww#/shared-invite/email) in the `#open-source` channel.
|
|
|
|
* [Read the wiki](https://github.com/symless/synergy/wiki)
|
|
* [Raise an issue](https://github.com/symless/synergy/issues)
|
|
* [Start a discussion](https://github.com/symless/synergy/discussions)
|
|
|
|
## Developer Quick Start
|
|
|
|
How to build Synergy 1 Community Edition. Check the [Developer Guide](https://github.com/symless/synergy/wiki/Developer-Guide) wiki page if you have problems.
|
|
|
|
**1. Dependencies:**
|
|
|
|
*Windows:*
|
|
```
|
|
python scripts/install_deps.py
|
|
```
|
|
|
|
*macOS/Linux:*
|
|
```
|
|
./scripts/install_deps.py
|
|
```
|
|
|
|
**2. Configure:**
|
|
|
|
*Windows:*
|
|
```
|
|
cmake -B build --preset=windows-release
|
|
```
|
|
|
|
*macOS:*
|
|
```
|
|
cmake -B build --preset=macos-release
|
|
```
|
|
|
|
*Linux:*
|
|
```
|
|
cmake -B build --preset=linux-release
|
|
```
|
|
|
|
**3. Build:**
|
|
```
|
|
cmake --build build -j8
|
|
```
|
|
|
|
**4. Test:**
|
|
```
|
|
./build/bin/unittests
|
|
```
|
|
|
|
## Packages
|
|
|
|
Synergy 1 Community Edition is packaged by the community (status shown below). Package maintainers can use `scripts/package.py` to build packages.
|
|
|
|
Synergy 2 is no longer in development and we recommend that package maintainers do not provide it.
|
|
|
|
Synergy 3 and Synergy 1 (licensed) are available to download from the [official packages](https://symless.com/synergy/download).
|
|
|
|
**Community edition:**
|
|
|
|
*Windows:*
|
|
```
|
|
choco install synergy
|
|
```
|
|
|
|
*macOS:*
|
|
```
|
|
brew install synergy
|
|
```
|
|
|
|
*Debian, Ubuntu, etc:*
|
|
```
|
|
sudo apt install synergy
|
|
```
|
|
|
|
*Fedora, Red Hat, etc:*
|
|
```
|
|
sudo dnf install synergy
|
|
```
|
|
|
|
*Arch, Manjaro, etc:*
|
|
```
|
|
sudo pacman -S synergy
|
|
```
|
|
|
|
*Repology:*
|
|
|
|
[](https://repology.org/project/synergy/versions)
|