docs: Deduplicate README contents, use a symlink
docs/index.md and README.md are almost identical, except for some paths and the metadata table on top of the file. Use absolute paths to the website to avoid breaking links, and symlink README.md.
This commit is contained in:
Peter Wu
Filipe Laíns
parent
a06ea6de11
commit
b9fb005c9c
96
README.md
96
README.md
|
|
@ -1,96 +0,0 @@
|
|||
**Solaar** is a Linux device manager for Logitech's [Unifying][unifying] Receiver
|
||||
peripherals. It is able to pair/unpair devices to the receiver, and for most
|
||||
devices read battery status.
|
||||
|
||||
It comes in two flavors, command-line and GUI. Both are able to list the
|
||||
devices paired to a Unifying Receiver, show detailed info for each device, and
|
||||
also pair/unpair supported devices with the receiver.
|
||||
|
||||
[unifying]: http://logitech.com/promotions/6072
|
||||
|
||||
## Supported Devices
|
||||
|
||||
**Solaar** will detect all devices paired with your Unifying Receiver, and at
|
||||
the very least display some basic information about them.
|
||||
|
||||
For some devices, extra settings (usually not available through the standard
|
||||
Linux system configuration) are supported. For a full list of supported devices
|
||||
and their features, see [docs/devices.md](docs/devices.md).
|
||||
|
||||
|
||||
## Pre-built packages
|
||||
|
||||
Pre-built packages are available for a few Linux distros.
|
||||
|
||||
* Arch `solaar` package in the [community repository][arch]
|
||||
* Debian 7 (Wheezy) or higher: packages in this [repository](docs/debian.md)
|
||||
* Ubuntu/Kubuntu 16.04+: use the `solaar-gnome3` and/or `solaar` package from [universe repository][universe repository]
|
||||
* Ubuntu/Kubuntu 12.04 to 14.04: use `solaar` package from [ppa:daniel.pavel/solaar][ppa]
|
||||
|
||||
The `solaar` package uses a standard system tray implementation; to ensure
|
||||
integration with *gnome-shell* or *Unity*, install `solaar-gnome3`.
|
||||
|
||||
* an [Arch AUR solaar-git package][arch-git], courtesy of Maxime Poulin
|
||||
* a [Fedora package][fedora], courtesy of Eric Smith
|
||||
* a [Gentoo package][gentoo], courtesy of Carlos Silva and Tim Harder
|
||||
* a [Mageia package][mageia], courtesy of David Geiger
|
||||
* an [OpenSUSE rpm][opensuse], courtesy of Mathias Homann
|
||||
|
||||
[ppa]: http://launchpad.net/~daniel.pavel/+archive/solaar
|
||||
[arch]: https://www.archlinux.org/packages/community/any/solaar/
|
||||
[arch-git]: https://aur.archlinux.org/packages/solaar-git/
|
||||
[fedora]: https://apps.fedoraproject.org/packages/solaar
|
||||
[gentoo]: https://packages.gentoo.org/packages/app-misc/solaar
|
||||
[mageia]: http://mageia.madb.org/package/show/release/cauldron/application/0/name/solaar
|
||||
[opensuse]: http://software.opensuse.org/package/Solaar
|
||||
[universe repository]: http://packages.ubuntu.com/search?keywords=solaar&searchon=names&suite=all§ion=all
|
||||
|
||||
|
||||
## Manual installation
|
||||
|
||||
See [docs/installation.md](docs/installation.md) for the step-by-step
|
||||
procedure for manual installation.
|
||||
|
||||
|
||||
## Known Issues
|
||||
|
||||
- KDE/Kubuntu: if some icons appear broken in the application, make sure you've
|
||||
properly configured the Gtk theme and icon theme in KDE's control panel.
|
||||
|
||||
- Some devices using the [Nano Receiver][nano] (which is very similar to the
|
||||
Unifying Receiver) are supported, but not all. For details, see
|
||||
[docs/devices.md](docs/devices.md).
|
||||
|
||||
- Running the command-line application (`bin/solaar-cli`) while the GUI
|
||||
application is also running *may* occasionally cause either of them to become
|
||||
confused about the state of the devices. I haven't encountered this often
|
||||
enough to be able to be able to diagnose it properly yet.
|
||||
|
||||
[nano]: http://support.logitech.com/en_us/parts
|
||||
|
||||
|
||||
## License
|
||||
|
||||
This software is distributed under the terms of the
|
||||
[GNU Public License, v2](COPYING).
|
||||
|
||||
|
||||
## Thanks
|
||||
|
||||
This project began as a third-hand clone of [Noah K. Tilton](https://github.com/noah)'s
|
||||
logitech-solar-k750 project on GitHub (no longer available). It was developed
|
||||
further thanks to the diggings in Logitech's HID++ protocol done by many other
|
||||
people:
|
||||
|
||||
- [Julien Danjou](http://julien.danjou.info/blog/2012/logitech-k750-linux-support),
|
||||
who also provided some internal
|
||||
[Logitech documentation](http://julien.danjou.info/blog/2012/logitech-unifying-upower)
|
||||
- [Lars-Dominik Braun](http://6xq.net/git/lars/lshidpp.git)
|
||||
- [Alexander Hofbauer](http://derhofbauer.at/blog/blog/2012/08/28/logitech-performance-mx)
|
||||
- [Clach04](http://bitbucket.org/clach04/logitech-unifying-receiver-tools)
|
||||
- [Peter Wu](https://lekensteyn.nl/logitech-unifying.html)
|
||||
- [Nestor Lopez Casado](http://drive.google.com/folderview?id=0BxbRzx7vEV7eWmgwazJ3NUFfQ28)
|
||||
provided some more Logitech specifications for the HID++ protocol
|
||||
|
||||
Also thanks to Douglas Wagner, Julien Gascard and Peter Wu for helping with
|
||||
application testing and supporting new devices.
|
||||
|
|
@ -20,7 +20,7 @@ the very least display some basic information about them.
|
|||
|
||||
For some devices, extra settings (usually not available through the standard
|
||||
Linux system configuration) are supported. For a full list of supported devices
|
||||
and their features, see [docs/devices.md]({{ site.baseurl }}/devices).
|
||||
and their features, see [docs/devices.md](https://pwr-solaar.github.io/Solaar/devices).
|
||||
|
||||
|
||||
## Pre-built packages
|
||||
|
|
@ -28,7 +28,7 @@ and their features, see [docs/devices.md]({{ site.baseurl }}/devices).
|
|||
Pre-built packages are available for a few Linux distros.
|
||||
|
||||
* Arch `solaar` package in the [community repository][arch]
|
||||
* Debian 7 (Wheezy) or higher: packages in this [repository]({{ site.baseurl }}/debian)
|
||||
* Debian 7 (Wheezy) or higher: packages in this [repository](https://pwr-solaar.github.io/Solaar/debian)
|
||||
* Ubuntu/Kubuntu 16.04+: use the `solaar-gnome3` and/or `solaar` package from [universe repository][universe repository]
|
||||
* Ubuntu/Kubuntu 12.04 to 14.04: use `solaar` package from [ppa:daniel.pavel/solaar][ppa]
|
||||
|
||||
|
|
@ -53,7 +53,7 @@ integration with *gnome-shell* or *Unity*, install `solaar-gnome3`.
|
|||
|
||||
## Manual installation
|
||||
|
||||
See [docs/installation.md]({{ site.baseurl }}/installation) for the step-by-step
|
||||
See [docs/installation.md](https://pwr-solaar.github.io/Solaar/installation) for the step-by-step
|
||||
procedure for manual installation.
|
||||
|
||||
|
||||
|
|
@ -64,7 +64,7 @@ procedure for manual installation.
|
|||
|
||||
- Some devices using the [Nano Receiver][nano] (which is very similar to the
|
||||
Unifying Receiver) are supported, but not all. For details, see
|
||||
[docs/devices.md]({{ site.baseurl }}/devices).
|
||||
[docs/devices.md](https://pwr-solaar.github.io/Solaar/devices).
|
||||
|
||||
- Running the command-line application (`bin/solaar-cli`) while the GUI
|
||||
application is also running *may* occasionally cause either of them to become
|
||||
|
|
|
|||
Loading…
Reference in New Issue