diff --git a/README.md b/README.md deleted file mode 120000 index e8923303..00000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -docs/index.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 00000000..8b93b6cb --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +# Solaar + +Solaar is a Linux manager for many Logitech keyboards, mice, and other devices +that connect wirelessly to a Unifying, Bolt, Lightspeed or Nano receiver +as well as many Logitech devices that connect via a USB cable or Bluetooth. + + +More Information - +Usage - +Capabilities - +Rules - +Manual Installation + + +[![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2+-blue.svg)](../COPYING) + + +  + + + +  + + +Solaar supports: +- pairing/unpairing of devices with receivers +- configuring device settings +- custom button configuration +- running rules in response to special messages from devices + +For more information see + the main Solaar documentation page. - + + +## Installation Packages + +Up-to-date prebuilt packages are available for some Linux distros +(e.g., Fedora) in their standard repositories. +If a recent version of Solaar is not +available from the standard repositories for your distribution, you can try +one of these packages: + +- Arch solaar package in the [extra repository][arch] +- Ubuntu/Kubuntu package in [Solaar stable ppa][ppa2] +- NixOS Flake package in [Svenum/Solaar-Flake][nix flake] + +Solaar is available from some other repositories +but may be several versions behind the current version: + +- for Ubuntu/Kubuntu 16.04+: the solaar package from [universe repository][universe repository] +- a [Gentoo package][gentoo], courtesy of Carlos Silva and Tim Harder +- a [Mageia package][mageia], courtesy of David Geiger + +[ppa2]: https://launchpad.net/~solaar-unifying/+archive/ubuntu/stable +[arch]: https://www.archlinux.org/packages/extra/any/solaar/ +[gentoo]: https://packages.gentoo.org/packages/app-misc/solaar +[mageia]: http://mageia.madb.org/package/show/release/cauldron/application/0/name/solaar +[universe repository]: http://packages.ubuntu.com/search?keywords=solaar&searchon=names&suite=all§ion=all +[nix flake]: https://github.com/Svenum/Solaar-Flake diff --git a/docs/Solaar-main-window-receiver-old.png b/docs/Solaar-main-window-receiver-old.png new file mode 100644 index 00000000..4de01bd5 Binary files /dev/null and b/docs/Solaar-main-window-receiver-old.png differ diff --git a/docs/Solaar-main-window-receiver.png b/docs/Solaar-main-window-receiver.png index 4de01bd5..8cf10dba 100644 Binary files a/docs/Solaar-main-window-receiver.png and b/docs/Solaar-main-window-receiver.png differ diff --git a/docs/index.md b/docs/index.md index 8f9eb4ac..9480c9f3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -106,12 +106,11 @@ available from the standard repositories for your distribution, you can try one of these packages. - Arch solaar package in the [extra repository][arch] -- Ubuntu/Kubuntu stable packages: use the [Solaar stable ppa][ppa2], courtesy of [gogo][ppa4] -- Ubuntu/Kubuntu git build packages: use the [Solaar git ppa][ppa1], courtesy of [gogo][ppa4] -- NixOS Flake: see [Svenum/Solaar-Flake][nix flake] +- Ubuntu/Kubuntu package in [Solaar stable ppa][ppa2] +- NixOS Flake package in [Svenum/Solaar-Flake][nix flake] Solaar is available from some other repositories -but they are several versions behind the current version. +but they may be several versions behind the current version. - for Ubuntu/Kubuntu 16.04+: the solaar package from [universe repository][universe repository] - a [Gentoo package][gentoo], courtesy of Carlos Silva and Tim Harder @@ -121,8 +120,6 @@ Solaar uses a standard system tray implementation; solaar-gnome3 is no longer re [ppa4]: https://launchpad.net/~trebelnik-stefina [ppa2]: https://launchpad.net/~solaar-unifying/+archive/ubuntu/stable -[ppa1]: https://launchpad.net/~solaar-unifying/+archive/ubuntu/ppa -[ppa]: http://launchpad.net/~daniel.pavel/+archive/solaar [arch]: https://www.archlinux.org/packages/extra/any/solaar/ [gentoo]: https://packages.gentoo.org/packages/app-misc/solaar [mageia]: http://mageia.madb.org/package/show/release/cauldron/application/0/name/solaar