Updated README
This commit is contained in:
Albert Vaca
parent
239f7f6830
commit
26d5bb8a68
1 changed files with 13 additions and 13 deletions
26
README.md
26
README.md
|
|
@ -4,32 +4,30 @@ KDE Connect is a multi-platform app that allows your devices to communicate (eg:
|
|||
|
||||
## (Some) Features
|
||||
- **Shared clipboard**: copy and paste between your phone and your computer (or any other device).
|
||||
- **Notification sync**: Read your Android notifications from the desktop.
|
||||
- **Notification sync**: Read and reply to your Android notifications from the desktop.
|
||||
- **Share files and URLs** instantly from one device to another.
|
||||
- **Multimedia remote control**: Use your phone as a remote for Linux media players.
|
||||
- **Virtual touchpad**: Use your phone screen as your computer's touchpad.
|
||||
- **Virtual touchpad**: Use your phone screen as your computer's touchpad and keyboard.
|
||||
|
||||
All this without wires, over the already existing WiFi network, and using a secure, encrypted protocol.
|
||||
All this without wires, over the already existing WiFi network, and using TLS encryption.
|
||||
|
||||
## Supported platforms
|
||||
- Computers running Plasma 5, KDE4, Unity (Ubuntu), Gnome 3, Elementary OS...
|
||||
- Computers running Linux with Plasma 5, Gnome 3, Elementary OS...
|
||||
- Android, by installing the [KDE Connect Android app](https://play.google.com/store/apps/details?id=org.kde.kdeconnect_tp) (also available on [F-Droid](https://f-droid.org/repository/browse/?fdid=org.kde.kdeconnect_tp)).
|
||||
|
||||
There is also source code for an unmaintained iOS port, waiting for somebody to give it some love :)
|
||||
|
||||
## How to install
|
||||
This explains how to install KDE Connect on your computer. You will also need to install it in your phone and pair both devices in the app if you want it to be any useful.
|
||||
|
||||
### On Linux
|
||||
Look in your distribution repo for a package called `kdeconnect-kde`, `kdeconnect-plasma`, or just `kdeconnect`. If it's not there and you know how to build software from sources, you just found the repo :)
|
||||
|
||||
If you are not using Plasma 5 or KDE4, you will also need to install [indicator-kdeconnect](https://github.com/vikoadi/indicator-kdeconnect) (available as an [Ubuntu PPA](https://code.launchpad.net/~vikoadi/+archive/ubuntu/ppa/)) for integration with other desktops using appindicator.
|
||||
If you are not using Plasma 5, you might want to install a user interface for your platform. The [indicator-kdeconnect](https://github.com/bajoja/indicator-kdeconnect) project provides an appindicator icon plus integration with Nautilus.
|
||||
|
||||
### On Mac or Windows
|
||||
There is no support for Mac or Windows yet. The last time I checked it was compiling on Windows, so it's only lacking a user interface. Same for Mac. Contributions welcome!
|
||||
Platforms other than Linux are not officially supported, but it should be possible to run KDE Connect there. You can compile KDE Connect for Windows using [Craft](https://community.kde.org/Craft) and it works except for some plugins. I haven't tried on Mac. Contributions welcome!
|
||||
|
||||
### On BSD
|
||||
It should work, but no promises.
|
||||
It should work, but no promises :)
|
||||
|
||||
## How does it work?
|
||||
KDE Connect consists of an UI-agnostic "core" library which exposes a series of DBus interfaces, and several UI components that consume these DBus interfaces. This way, new UI components can be added to integrate better with specific platforms or desktops, without having to reimplement the protocol or any of the internals. The core KDE Connect library is also divided in 4 big blocks:
|
||||
|
|
@ -39,7 +37,7 @@ KDE Connect consists of an UI-agnostic "core" library which exposes a series of
|
|||
- **NetworkPackets**: JSON-serializable and self-contained pieces of information to be sent by the plugins between devices.
|
||||
- **Plugins**: Independent pieces of code which implement a specific feature. Plugins will use NetworkPackets to exchange information through the network with other Plugins on a remote Device.
|
||||
|
||||
The basic structure of a NetworkPacket (before encryption) is the following:
|
||||
The basic structure of a NetworkPacket is the following:
|
||||
|
||||
```
|
||||
{
|
||||
|
|
@ -57,9 +55,11 @@ NetworkPackets can also have binary data attached that can't be serialized to JS
|
|||
`"payloadSize"`: The size of the file, or -1 if it is a stream without known size.
|
||||
`"payloadTransferInfo"`: Another JSON object where the specific Link can add information so the Link in the remote end can establish a connection and receive the payload (eg: IP and port in a local network). It's up to the Link implementation to decide how to use this field.
|
||||
|
||||
## Contributing
|
||||
|
||||
To contribute patches, use [KDE Connect's Phabricator](https://phabricator.kde.org/project/profile/159/). There you can also find a task list with stuff to do, and links to other relevant resources. It is a good idea to also subscribe to the [KDE Connect mailing list](https://mail.kde.org/mailman/listinfo/kdeconnect).
|
||||
|
||||
## License
|
||||
[GNU GPL v2](https://www.gnu.org/licenses/gpl-2.0.html) and [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.html)
|
||||
|
||||
If you are reading this from Github, you should know that this is just a mirror of the [KDE Project repo](https://projects.kde.org/projects/extragear/network/kdeconnect-kde/repository/).
|
||||
|
||||
[](https://build.kde.org/job/kdeconnect-kde%20master%20kf5-qt5/)
|
||||
If you are reading this from Github, you should know that this is just a mirror of the [KDE Project repo](https://cgit.kde.org/kdeconnect-kde.git).
|
||||
|
|
|
|||
Loading…
Reference in a new issue