481680d072
* Don't run CodeQL in PR draft * Speed up analysis workflows * Run install deps on Debian * Add badge to readme * Fixed copy and use workdir * Use mount instead of copy * Fixed unwanted && and changed workdir * Split deps and deps-full * Fixed context * Use /app dir * Use copy instead * Revert to --mount and use .py (not .sh) * Test * Add `./scripts/install_deps.py` to all platforms * Add missing syntax * Fixed Python dep for OpenSUSE * Temp remove WORKDIR for OpenSUSE * Re-add workdir * Increase timeout * Delete `zypper --non-interactive remove busybox-which` * Restore python3 * Test * Rename to `lint-source-code` * Beef up analysis runners * Fixed workflow runs-on * Use deps script * Try pipx for gcovr * Use containers with deps * Add -y arg * Install curl * Merge deps step * Add unzip dep * Make Git dir safe * Add .local/bin to env * Improve step name * Use `pipx ensurepath` * Install gcovr with apt * Use Ubuntu 22 with pip * Update ChangeLog * Use 16-core for Windows * Use choco cache * Test * Use 8-core for Windows (picked up quicker, more available?)
62 lines
2.3 KiB
Markdown
62 lines
2.3 KiB
Markdown
# Synergy Core
|
|
|
|
[](https://github.com/symless/synergy-core/actions/workflows/ci.yml)
|
|
[](https://github.com/symless/synergy-core/actions/workflows/codeql-analysis.yml)
|
|
[](https://github.com/symless/synergy-core/actions/workflows/sonarcloud-analysis.yml)
|
|
[](https://github.com/symless/synergy-core/actions/workflows/build-containers.yml)
|
|
|
|
This is the open source core component of Synergy, a keyboard and mouse sharing tool.
|
|
|
|
* [Download Synergy](https://symless.com/synergy/download)
|
|
* [Contact support](https://symless.com/synergy/contact)
|
|
* [Help articles](https://symless.com/synergy/help)
|
|
|
|
## Developer quick start
|
|
|
|
Simplified instructions for those who want to contribute to development of Synergy Core.
|
|
|
|
You'll also need to read the
|
|
[quick start companion](https://github.com/symless/synergy-core/wiki/Quick-start-companion)
|
|
which contains essential instructions.
|
|
|
|
**Dependencies:**
|
|
```
|
|
python scripts/install_deps.py
|
|
```
|
|
|
|
**Configure:**
|
|
|
|
*Windows:*
|
|
```
|
|
cmake -B build --preset=windows-release
|
|
```
|
|
|
|
*macOS:*
|
|
```
|
|
cmake -B build --preset=macos-release
|
|
```
|
|
|
|
*Linux:*
|
|
```
|
|
cmake -B build --preset=linux-release
|
|
```
|
|
|
|
**Build:**
|
|
```
|
|
cmake --build build -j8
|
|
```
|
|
|
|
**Test:**
|
|
```
|
|
./build/bin/unittests
|
|
```
|
|
|
|
## Developer resources
|
|
|
|
For people who want to contribute to the development of Synergy.
|
|
|
|
* [Getting started](https://github.com/symless/synergy-core/wiki/Getting-Started) - How to checkout the code from git and use the right branch.
|
|
* [Compiling](https://github.com/symless/synergy-core/wiki/Compiling) - Instructions on how to compile Synergy Core from source.
|
|
* [Text config](https://github.com/symless/synergy-core/wiki/Text-Config) - Write a text config file when running Synergy Core manually.
|
|
* [Command line](https://github.com/symless/synergy-core/wiki/Command-Line) - Go full manual and run Synergy Core from the command line.
|
|
* [Synergy Vintage](https://github.com/nbolton/synergy-vintage) - Use Synergy on operating systems available between 1995 and 2006.
|