d0a4c3d7a0
* Use deps script to make life easier for contribs * Make readme more developer friendly * YAML file to describe Linux deps * Silent fail for yaml module (Python 3.6+) * Move Qt install to deps script * Update readme to add Windows command * Fixed Linux package name * Simplify env vars for workflow * Exclude scripts from SonarCloud * Move all deps config to .yml file * Fixed exclude glob * Simplify quickstart * Fixed macOS deps config key name * Fixed bug in Linux config read * Use backslash for consistency * Change SonarCloud path to /build/ * Fixed dep name * Exclude scripts in CMake coverage * Move script coverage exclusion to online config * Use try/except instead of checking return value * Fixed comment typo
57 lines
1.6 KiB
Markdown
57 lines
1.6 KiB
Markdown
# Synergy Core
|
|
|
|
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
|
|
```
|
|
|
|
**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.
|