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

docs: Improve readability of readme

Browse source 
- Condensed and deduped the Synergy sponsor text
- Add more headings to make sections clearer
- Add rewarded bounty badge
This commit is contained in:
Nick Bolton 2025-05-01 12:57:29 +01:00
parent d643e4b189
commit 0c94adf03c
1 changed files with 30 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

67
README.md
View file

@ -1,28 +1,22 @@
![Deskflow](https://github.com/user-attachments/assets/f005b958-24df-4f4a-9bfd-4f834dae59d6) ![Deskflow](https://github.com/user-attachments/assets/f005b958-24df-4f4a-9bfd-4f834dae59d6)
> [!TIP]
> [Synergy](https://symless.com/synergy) sponsors the Deskflow project by contributing code and providing financial support.
>
> - [**Bounties**](https://github.com/deskflow/deskflow/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22%F0%9F%92%8E%20bounty%22) - Earn while contributing to open source
> - [**Rewarded**](https://github.com/deskflow/deskflow/issues?q=label%3A%22%F0%9F%92%B0%20rewarded%22%20) - Issues with a rewarded bounty
>
> **Deskflow** is the official upstream project for Synergy.
> Purchasing a Synergy license is one way to support Deskflow’s growth and sustainability.
> Learn more: [Relationship with Synergy](https://github.com/deskflow/deskflow/wiki/Relationship-with-Synergy)
**Deskflow** is a free and open source keyboard and mouse sharing app. **Deskflow** is a free and open source keyboard and mouse sharing app.
Use the keyboard, mouse, or trackpad of one computer to control nearby computers, Use the keyboard, mouse, or trackpad of one computer to control nearby computers,
and work seamlessly between them. and work seamlessly between them.
It's like a software KVM (but without the video). It's like a software KVM (but without the video).
TLS encryption is enabled by default. Wayland is supported. Clipboard sharing is supported. TLS encryption is enabled by default. Wayland is supported. Clipboard sharing is supported.
[![Downloads: Stable Release](https://img.shields.io/github/downloads/deskflow/deskflow/latest/total?style=for-the-badge&logo=github&label=Download%20Stable)](https://github.com/deskflow/deskflow/releases/latest)      [![Downloads: Continuous Build](https://img.shields.io/github/downloads/deskflow/deskflow/continuous/total?style=for-the-badge&logo=github&label=Download%20Continuous)](https://github.com/deskflow/deskflow/releases/continuous)      [![Download From Flathub](https://img.shields.io/flathub/downloads/org.deskflow.deskflow?style=for-the-badge&logo=flathub&label=Download%20from%20flathub)](https://flathub.org/apps/org.deskflow.deskflow) ## Download
To use Deskflow you can use one of our [packages](https://github.com/deskflow/deskflow/releases), install `deskflow` (if available in your package repository), or [build it](#build-quick-start) yourself from source. [![Downloads: Stable Release](https://img.shields.io/github/downloads/deskflow/deskflow/latest/total?style=for-the-badge&logo=github&label=Download%20Stable)](https://github.com/deskflow/deskflow/releases/latest)      [![Downloads: Continuous Build](https://img.shields.io/github/downloads/deskflow/deskflow/continuous/total?style=for-the-badge&logo=github&label=Download%20Continuous)](https://github.com/deskflow/deskflow/releases/continuous)      [![Download From Flathub](https://img.shields.io/flathub/downloads/org.deskflow.deskflow?style=for-the-badge&logo=flathub&label=Download%20from%20flathub)](https://flathub.org/apps/org.deskflow.deskflow)
> [!TIP] > [!TIP]
> For macOS users, the easiest way to install and stay up to date is to use [Homebrew](https://brew.sh) with our [homebrew-tap](https://github.com/deskflow/homebrew-tap). > For macOS users, the easiest way to install and stay up to date is to use [Homebrew](https://brew.sh) with our [homebrew-tap](https://github.com/deskflow/homebrew-tap).
To use Deskflow, download one of our [packages](https://github.com/deskflow/deskflow/releases), install `deskflow` (from your package repository), or [build it](#build-quick-start) from source.
## Stats
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/deskflow/deskflow?logo=github)](https://github.com/deskflow/deskflow/commits/master/) [![GitHub commit activity](https://img.shields.io/github/commit-activity/m/deskflow/deskflow?logo=github)](https://github.com/deskflow/deskflow/commits/master/)
[![GitHub top language](https://img.shields.io/github/languages/top/deskflow/deskflow?logo=github)](https://github.com/deskflow/deskflow/commits/master/) [![GitHub top language](https://img.shields.io/github/languages/top/deskflow/deskflow?logo=github)](https://github.com/deskflow/deskflow/commits/master/)
[![GitHub License](https://img.shields.io/github/license/deskflow/deskflow?logo=github)](LICENSE) [![GitHub License](https://img.shields.io/github/license/deskflow/deskflow?logo=github)](LICENSE)
@ -39,25 +33,14 @@ To use Deskflow you can use one of our [packages](https://github.com/deskflow/de
## Contribute ## Contribute
[![Good first issues](https://img.shields.io/github/issues/deskflow/deskflow/good%20first%20issue?label=good%20first%20issues&color=%2344cc11)](https://github.com/deskflow/deskflow/labels/good%20first%20issue) [![Open bounty issues](https://img.shields.io/github/issues/deskflow/deskflow/%F0%9F%92%8E%20bounty?label=💎%20open%20bounty%20issues&color=%2344cc11)](https://github.com/deskflow/deskflow/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22%F0%9F%92%8E%20bounty%22) [![Rewarded bounties](https://img.shields.io/github/issues-search/deskflow/deskflow?query=label%3A%22%F0%9F%92%B0%20rewarded%22&label=%F0%9F%92%B0%20rewarded%20bounties&color=yellow)](https://github.com/deskflow/deskflow/issues?q=label%3A%22%F0%9F%92%B0%20rewarded%22%20sort%3Aupdated-desc)
There are many ways to contribute to the Deskflow project. There are many ways to contribute to the Deskflow project.
We're a friendly, active, and welcoming community focused on building a great app. We're a friendly, active, and welcoming community focused on building a great app.
Read our [Contributing](https://github.com/deskflow/deskflow/wiki/Contributing) page to get started. Read our [Contributing](https://github.com/deskflow/deskflow/wiki/Contributing) page to get started.
[![Good first issues](https://img.shields.io/github/issues/deskflow/deskflow/good%20first%20issue?label=good%20first%20issues&color=%2344cc11
)](https://github.com/deskflow/deskflow/labels/good%20first%20issue) [![Open bounty issues](https://img.shields.io/github/issues/deskflow/deskflow/%F0%9F%92%8E%20bounty?label=💎%20bounty%20issues&color=%2344cc11)](https://github.com/deskflow/deskflow/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22%F0%9F%92%8E%20bounty%22)
## Project Values
- Motivated by the community interests (not business-driven)
- Privacy by default (e.g. update check is off by default)
- Leading edge releases (we don't focus on supporting older systems)
- Decisions are discussed and documented publicly with majority rule
- Have fun; we don't need to worry about impressing anyone
## Build Quick Start
For instructions on building Deskflow, use the wiki page: [Building](https://github.com/deskflow/deskflow/wiki/Building) For instructions on building Deskflow, use the wiki page: [Building](https://github.com/deskflow/deskflow/wiki/Building)
## Operating Systems ## Operating Systems
@ -102,46 +85,39 @@ macOS users who download directly from releases may need to run `xattr -c /Appli
It is recommend to install Deskflow using [Homebrew](https://brew.sh) from our [homebrew-tap](https://github.com/deskflow/homebrew-tap) It is recommend to install Deskflow using [Homebrew](https://brew.sh) from our [homebrew-tap](https://github.com/deskflow/homebrew-tap)
To add our tap, run: To add our tap, run:
``` ```
brew tap deskflow/homebrew-tap brew tap deskflow/homebrew-tap
``` ```
Then install either: Then install either:
- Stable: `brew install deskflow` - Stable: `brew install deskflow`
- Continuous: `brew install deskflow-dev` - Continuous: `brew install deskflow-dev`
## Similar Projects
## Collaborative Projects
In the open source developer community, similar projects collaborate for the improvement of all In the open source developer community, similar projects collaborate for the improvement of all
mouse and keyboard sharing tools. We aim for idea sharing and interoperability. mouse and keyboard sharing tools. We aim for idea sharing and interoperability.
* [**Lan Mouse**](https://github.com/feschber/lan-mouse) - - [**Lan Mouse**](https://github.com/feschber/lan-mouse) -
Rust implementation with the goal of having native front-ends and interoperability with Rust implementation with the goal of having native front-ends and interoperability with
Deskflow/Synergy. Deskflow/Synergy.
* [**Input Leap**](https://github.com/input-leap/input-leap) - - [**Input Leap**](https://github.com/input-leap/input-leap) -
Deskflow/Synergy-derivative with the goal of continuing what Barrier started, after Barrier Deskflow/Synergy-derivative with the goal of continuing what Barrier started, after Barrier
became a dead fork. became a dead fork.
* [**Synergy**](https://github.com/deskflow/deskflow/wiki/Relationship-with-Synergy) - - [**Synergy**](https://symless.com/synergy) -
Downstream commercial fork and Deskflow sponsor, geared toward adapting to customer Downstream commercial fork. Synergy sponsors Deskflow with financial support and contributes code ([learn more](https://github.com/deskflow/deskflow/wiki/Relationship-with-Synergy)).
needs, offering business and enterprise licensing.
## FAQ ## FAQ
### What is the relationship with Synergy?
[![Sponsored by: Synergy](https://raw.githubusercontent.com/deskflow/deskflow-artwork/b2c72a3e60a42dee793bd47efc275b5ee0bdaa5f/misc/synergy-sponsor.svg)](https://github.com/deskflow/deskflow/wiki/Relationship-with-Synergy)
Synergy sponsors the Deskflow project by contributing code and providing financial support while maintaining its customer-oriented code downstream.
Learn more: [Relationship with Synergy](https://github.com/deskflow/deskflow/wiki/Relationship-with-Synergy)
### Is Deskflow compatible with Synergy, Input Leap, or Barrier? ### Is Deskflow compatible with Synergy, Input Leap, or Barrier?
Yes, Deskflow has network compatibility with all forks: Yes, Deskflow has network compatibility with all forks:
- Requires Deskflow >= v1.17.0.96 - Requires Deskflow >= v1.17.0.96
- Deskflow will *just work* with Input Leap and Barrier (server or client). - Deskflow will _just work_ with Input Leap and Barrier (server or client).
- Connecting a Deskflow client to a Synergy 1 server will also *just work*. - Connecting a Deskflow client to a Synergy 1 server will also _just work_.
- To connect a Synergy 1 client, you need to select the Synergy protocol in the Deskflow server settings. - To connect a Synergy 1 client, you need to select the Synergy protocol in the Deskflow server settings.
_Note:_ Only Synergy 1 is compatible with Deskflow (Synergy 3 is not yet compatible). _Note:_ Only Synergy 1 is compatible with Deskflow (Synergy 3 is not yet compatible).
@ -184,9 +160,12 @@ wiki.
![Meow'Dib](https://github.com/user-attachments/assets/726f695c-3dfb-4abd-875d-ed658f6c610f) ![Meow'Dib](https://github.com/user-attachments/assets/726f695c-3dfb-4abd-875d-ed658f6c610f)
## Deskflow Contributors ## Deskflow Contributors
[![Sponsored by Synergy](https://raw.githubusercontent.com/deskflow/deskflow-artwork/b2c72a3e60a42dee793bd47efc275b5ee0bdaa5f/misc/synergy-sponsor.svg)](https://symless.com/synergy)
[Synergy](https://symless.com/synergy) sponsors the Deskflow project by contributing code and providing financial support ([learn more](https://github.com/deskflow/deskflow/wiki/Relationship-with-Synergy)).
Deskflow is made by possible by these contributors. Deskflow is made by possible by these contributors.
<a href = "https://github.com/deskflow/deskflow/graphs/contributors"> <a href = "https://github.com/deskflow/deskflow/graphs/contributors">