smw/deskflow
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
deskflow/README.md

96 lines
3.2 KiB
Markdown
Raw Normal View History

#6485 Copied README.md from v2-dev to master
2019-04-26 16:02:45 +00:00
# Synergy Core
Move quality gate badge to front of badges (#7410)
2024-07-23 09:24:47 +00:00
[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=symless_synergy-core&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=symless_synergy-core)
Add workflow status badges to README (#7359)
2024-06-26 16:42:02 +00:00
[![CI](https://github.com/symless/synergy-core/actions/workflows/ci.yml/badge.svg)](https://github.com/symless/synergy-core/actions/workflows/ci.yml)
[![CodeQL Analysis](https://github.com/symless/synergy-core/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/symless/synergy-core/actions/workflows/codeql-analysis.yml)
[![SonarCloud Analysis](https://github.com/symless/synergy-core/actions/workflows/sonarcloud-analysis.yml/badge.svg)](https://github.com/symless/synergy-core/actions/workflows/sonarcloud-analysis.yml)
Run `install_deps.py` script when building containers weekly (#7384) * 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?)
2024-07-11 14:26:38 +00:00
[![Build containers](https://github.com/symless/synergy-core/actions/workflows/build-containers.yml/badge.svg)](https://github.com/symless/synergy-core/actions/workflows/build-containers.yml)
Add workflow status badges to README (#7359)
2024-06-26 16:42:02 +00:00
Improve wording on README and add screenshot
2024-08-11 00:22:50 +00:00
[Synergy](https://symless.com/synergy) is a keyboard and mouse sharing tool.
Add Slack and Discord links to README
2024-08-01 15:35:10 +00:00
Improve wording on README and add screenshot
2024-08-11 00:22:50 +00:00
Use the keyboard, mouse, or trackpad of one computer to control nearby computers, and work seamlessly between them.
Clarify that no serial key is required in README.md
2024-08-14 16:16:01 +00:00
This project contains the source code for Synergy 1 Community Edition which is actively maintained and free to use (no serial key is required for the community edition).
Improve wording on README and add screenshot
2024-08-11 00:22:50 +00:00
Correct mistake in README.md screenshot
2024-08-11 00:59:23 +00:00
![Synergy 1 Community Edition](https://github.com/user-attachments/assets/faf5bd69-336c-4bd0-ace3-e911f199d961)
Improve build instructions in README
2024-07-30 19:48:29 +00:00
Improve wording on README and add screenshot
2024-08-11 00:22:50 +00:00
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.
#6485 Copied README.md from v2-dev to master
2019-04-26 16:02:45 +00:00
Update README.md
2024-08-04 19:04:13 +00:00
* [Download Synergy](https://symless.com/synergy/download)
* [Contact support](https://symless.com/synergy/contact)
Use deps script to make life easier for contribs (#7351) * 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
2024-06-14 15:32:47 +00:00
* [Help articles](https://symless.com/synergy/help)
Update README.md (#7398)
2024-07-16 09:27:21 +00:00
* [Project Wiki](https://github.com/symless/synergy-core/wiki)
#6485 Copied README.md from v2-dev to master
2019-04-26 16:02:45 +00:00
Improve build instructions in README
2024-07-30 19:48:29 +00:00
## Developer Quick Start
#6485 Copied README.md from v2-dev to master
2019-04-26 16:02:45 +00:00
Update wording on README.md
2024-08-11 01:09:06 +00:00
How to build Synergy 1 Community Edition. Check the [Developer Guide](https://github.com/symless/synergy-core/wiki/Developer-Guide) wiki page if you have problems.
#6485 Copied README.md from v2-dev to master
2019-04-26 16:02:45 +00:00
Use deps script to make life easier for contribs (#7351) * 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
2024-06-14 15:32:47 +00:00
**Dependencies:**
```
python scripts/install_deps.py
```
#6485 Copied README.md from v2-dev to master
2019-04-26 16:02:45 +00:00
Use deps script to make life easier for contribs (#7351) * 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
2024-06-14 15:32:47 +00:00
**Configure:**
*Windows:*
```
cmake -B build --preset=windows-release
```
*macOS:*
```
cmake -B build --preset=macos-release
```
*Linux:*
```
cmake -B build --preset=linux-release
```
Update README.md
2021-02-12 11:56:11 +00:00
Use deps script to make life easier for contribs (#7351) * 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
2024-06-14 15:32:47 +00:00
**Build:**
```
Re-implement packaging for GitHub workflows (Linux) (#7361) * Reorganize CMake Packaging module * Match if statements to function order * Cleanup root, res, and doc dirs * Move deps to requirements.txt file * Reorganize and format CMake files * Rename changelog lint * Add reccomended extension * Workflow to lint CMake files * Move CMake lint to script * Try lighter dep * Use venv * Add --format arg * Format all CMake files * Convert bash script to Python * Set CMake line ending format * Restore formatting * Add pyyaml dep * Remove unused arg * Rename config file * Remove comment * Repair copyrights (broken by defualt cmake-format) * Restore 3rd party copyright * Break up libs config into smaller macros * Better macro name * Load config after venv * Make intentional noop clearer * Only use upload step if required (make skip clearer) * Use CPack for deb and rpm packaging * Add upload step for Linux * Remove cpack dep, doesn't exist * Roll back presets version * Fixed distro like match * Update ChangeLog * Legacy checkout for some distros * All distros support v4 * Trying out newer Linux distros * Install Git on Docker images * Install without actions (not available before checkout) * Delete useless action * Install Python * Support for Arch and OpenSUSE * Add Arch and OpenSUSE to deps * Name steps * Full OpenSUSE names * Mark Git dir safe * Add pkgconf * Legacy CMake for Debian 11 * Add OpenSSL to OpenSUSE * Drop OpenSUSE Leap (no C++20 support) * Skip packaging for Arch and OpenSUSE (for now) * Shorten Arch/OpenSUSE names * Clearer step name * SImpler bootstrap * Shell not needed * Update apt * Don't check return code * Simplify python deps commands * Add STGZ/.sh package type * Prevent input prompt * Only config git safe dir when needed * Try cache v4 * Safe dir for Ubuntu * Safe dir for Arch * All Docker images seem to need safe dir config * Refactor env var getters * Make Ubuntu build extra packages * Condense bootstep to single step * Fixed var name * Fixed bootstrap logic * Simplify logic for upload condition (Windows and macOS) * Make package/upload condition easier to understand * Add Manjaro * Generic names for Linux .tar.gz and .sh packages * Add Manjaro deps * Swap macOS matrix entries * Add Red Hat UBI * Remove RHEL subscription manager * Throw on unsupported package distro * Conditionally install pip and venv * Remove extra pip arg * Add config for RHEL * Install EPEL for RHEL * Back-out RHEL as EPEL requires subscription * Restore Python deps logic * Fixed bug: Packacking run twice * Testing arm32v7 and arm64v8 * Revert "Testing arm32v7 and arm64v8" This reverts commit cb3caf188d2b79ed083a62fc091de295f9889f3d. * Re-add icon and shortcut file for Linux to package * Support OpenSUSE RPM build * Check return code * Add `rpm-build` for OpenSUSE * Reorg packages * Remove busybox-which * Add --non-interactive * Move --non-interactive to correct position * Experiment with makepkg * Check and print package commands * Make distro version optional * Use 8 cores to build * Default to distro name only * Fixed bad PKGBUILD filename * Use 4-part version for Arch * Remove comma from conflicts * Use .tar.gz from cwd * Generate checksum for Arch * Fixed file extension * Use shell to print output * Don't use shell * Gaurd against bad cmd_utils.run * Fixed bad import * Use list command * Fixed unable to run list commands * Use source file name * Simplify PKGBUILD to use make install * Change install prefix * Use DESTDIR * Copy .desktop and .png to build dir * Restore original `install(FILES...` * Improving comments * Fixed: makepkg runs from `src` by default * Move error after command print * Remove shell arg * Package as a user instead of root (makepkg can't run as root) * Fixed codesign runs in shell * Allow list commands in shell on windows * Don't use sudo on arch * Install sudo on Arch * Fixed typo * Fix ownership of build directory for package user * Improve example .env * Change to depend on libstdc++6 * Add TODO * Fixed Fedora version * Remove libstdc++ deps (names vary between distros) * Roll back to Fedora 40 and 39 * Improve comment * Remove unneccesary default
2024-07-02 10:23:56 +00:00
cmake --build build -j8
Use deps script to make life easier for contribs (#7351) * 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
2024-06-14 15:32:47 +00:00
```
Add link to Synergy Vintage
2022-05-03 09:16:48 +00:00
Use deps script to make life easier for contribs (#7351) * 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
2024-06-14 15:32:47 +00:00
**Test:**
```
./build/bin/unittests
```
Add Alma Linux and Rocky Linux runners (#7424) * Add RHEL image * Use Fedora config for RHEL * Use script to activate RHEL * Mirror mount args * Set RHEL username and password * Pass RHEL build args * Pass RHEL login by file * Use RHEL 9 for newer Python * Source RHEL login * Add case for RHEL Python deps * Add `--deactivate` * Do PIP user install * Upgrade PIP * Add RHEL config * Introduce 'command-pre' * Inherit fedora deps for RHEL and only strip sudo on non-empty command * Add RHEL 9 runner * Use RHEL 9 codeready * Add AlmaLinux EL9 * Add support for RHEL-like * Add EPEL for Alma * Enable power tools on Alma * Fix missing semicolon * Install EPEL before power tools * Inherit Alma deps from RHEL * Switch from `powertools` to `crb` * Abandon RHEL for now (no Qt 6 support) * Don't pass required when getting distro key * Correct key name for Rocky Linux * Add Repology badge * Restore original `build-push-action` * Exclude unsupported Repology entries * Update ChangeLog
2024-08-04 19:04:40 +00:00
## Packages
Update README.md to include install instructions
2024-08-12 16:23:06 +00:00
Synergy 1 Community Edition is packaged by the community (status shown below).
Add Alma Linux and Rocky Linux runners (#7424) * Add RHEL image * Use Fedora config for RHEL * Use script to activate RHEL * Mirror mount args * Set RHEL username and password * Pass RHEL build args * Pass RHEL login by file * Use RHEL 9 for newer Python * Source RHEL login * Add case for RHEL Python deps * Add `--deactivate` * Do PIP user install * Upgrade PIP * Add RHEL config * Introduce 'command-pre' * Inherit fedora deps for RHEL and only strip sudo on non-empty command * Add RHEL 9 runner * Use RHEL 9 codeready * Add AlmaLinux EL9 * Add support for RHEL-like * Add EPEL for Alma * Enable power tools on Alma * Fix missing semicolon * Install EPEL before power tools * Inherit Alma deps from RHEL * Switch from `powertools` to `crb` * Abandon RHEL for now (no Qt 6 support) * Don't pass required when getting distro key * Correct key name for Rocky Linux * Add Repology badge * Restore original `build-push-action` * Exclude unsupported Repology entries * Update ChangeLog
2024-08-04 19:04:40 +00:00
Synergy 2 is no longer in development and should not be provided.
Update README.md to include install instructions
2024-08-12 16:23:06 +00:00
For the licensed builds of Synergy 1 and Synergy 3, please use the [official packages](https://symless.com/synergy/download).
**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 -Syu synergy
```
Update package instructions for S1/S3
2024-08-04 19:26:09 +00:00
Add Alma Linux and Rocky Linux runners (#7424) * Add RHEL image * Use Fedora config for RHEL * Use script to activate RHEL * Mirror mount args * Set RHEL username and password * Pass RHEL build args * Pass RHEL login by file * Use RHEL 9 for newer Python * Source RHEL login * Add case for RHEL Python deps * Add `--deactivate` * Do PIP user install * Upgrade PIP * Add RHEL config * Introduce 'command-pre' * Inherit fedora deps for RHEL and only strip sudo on non-empty command * Add RHEL 9 runner * Use RHEL 9 codeready * Add AlmaLinux EL9 * Add support for RHEL-like * Add EPEL for Alma * Enable power tools on Alma * Fix missing semicolon * Install EPEL before power tools * Inherit Alma deps from RHEL * Switch from `powertools` to `crb` * Abandon RHEL for now (no Qt 6 support) * Don't pass required when getting distro key * Correct key name for Rocky Linux * Add Repology badge * Restore original `build-push-action` * Exclude unsupported Repology entries * Update ChangeLog
2024-08-04 19:04:40 +00:00
[![Repology](https://repology.org/badge/vertical-allrepos/synergy.svg?exclude_unsupported=1)](https://repology.org/project/synergy/versions)
Reference in a new issue Copy permalink