[SCM] kdeconnect packaging branch, master, updated. debian/0.9g-1-1183-g9d69498
Maximiliano Curia
maxy at moszumanska.debian.org
Fri Oct 14 14:28:33 UTC 2016
Gitweb-URL: http://git.debian.org/?p=pkg-kde/kde-extras/kdeconnect.git;a=commitdiff;h=a5b105c
The following commit has been merged in the master branch:
commit a5b105cb1ca8f38ed82172ab091af5e4c875d61a
Author: Albert Vaca <albertvaka at gmail.com>
Date: Fri May 8 23:15:58 2015 -0700
Markdown README
---
README | 76 ---------------------------------------------------------------
README.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 65 insertions(+), 76 deletions(-)
diff --git a/README b/README
deleted file mode 100644
index eef0431..0000000
--- a/README
+++ /dev/null
@@ -1,76 +0,0 @@
-Class diagram
-==============
-
- Backend_1 ... Backend_N
- \ | /
- Daemon
- / | \
- Device_1 ... Device_N
- / \
- |-Plugin_1 |-DeviceLink_1
- |-Plugin_2 |-DeviceLink_2
- |- ... |-...
- |-Plugin_N |-DeviceLink_N
-
-
-Daemon instantiates Backends
-
-Backends manage to create DeviceLinks with the devices they can reach, and Q_EMIT them to the Daemon.
-
-When the Daemon receives a DeviceLink from a backend:
- - If it already knows the Device, adds the new DeviceLink to the existing Device, as a new way to reach it.
- - If not, it creates a new untrusted (yet to be paired) Device.
-
-Devices contain a list of DeviceLinks, plus a list of Plugins (instantiated automatically)
-
-Information for and from Plugins is encapsulated in NetworkPackages.
-
-When a DeviceLink receives a NetworkPackage from the device in the other end, Device will notify all the plugins.
-
-When a Plugin wants to send a NetworkPackage, it does so using the pointer to Device
-
-
-
-The NetworkPackage format
-=========================
-
-NetworkPackages are independent and self-contained pieces of information that
-are sent from one device to another (via a DeviceLink) serialized in json.
-
-The basic structure of a NetworkPackage is the following:
-
-{
- "id": 123456789,
- "type": "org.kde.whatever",
- "body": {
-
- },
- "version": 5
-}
-
-Each type of package defines what it should contain inside its "body", so only
-the emisor plugin and receiver plugin of this type of package need agree about
-its content. Each plugin should provide a README explaining what does it write
-in the "body" section, to ease porting to other platforms.
-
-If the package has a payload attached, it will also contain two more fields:
- "payloadSize": The size of the file, or -1 if it is a stream without known end
- "payloadTransferInfo": Another JSON Object containing the information that the
- backend wants to send to the peer backend, to actually
- transfer the payload.
-
-Encrypted network packages have the following format:
-
- "type": is always set to "kdeconnect.encrypted".
- "id": contains a new valid id (ie: not the same id as the unencrypted package).
- "version": contains the package version.
- "body": contains a "data" array that carries the original package encrypted.
-
-The "data" array is filled the following way:
-
- 1. The original package is serialized.
- 2. The serialized string is divided in chunks small enough to be encrypted with
- the other device's public key.
- 3. Each chunk is encrypted and appended to the array in order.
-
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..eeaec40
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+# KDE Connect - desktop app
+
+KDE Connect is a multi-platform app that allows your devices to communicate (eg: your phone and your computer).
+
+## (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.
+- **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.
+
+All this without wires, over the already existing WiFi network, and using a secure, encrypted protocol.
+
+## Supported platforms
+- Computers running Plasma 5, KDE4, Unity (Ubuntu), 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.
+
+### 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!
+
+### On BSD
+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:
+
+- **LinkProviders**: Are in charge of discovering other KDE Connect-enabled devices in the network and establishing a Link to them.
+- **Devices**: Represent a remote device, abstracting the specific Link that is being used to reach it.
+- **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:
+
+```
+{
+ "id": 123456789,
+ "type": "com.example.myplugin",
+ "body": { },
+ "version": 5
+}
+```
+
+The content of the `"body"` section is defined by each Plugin. Hence, only the only the emisor and receiver plugins of a given packet type need agree on the contents of the body.
+
+NetworkPackets can also have binary data attached that can't be serialized to JSON. In this case, two new fields will be added:
+
+`"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.
+
+## 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/playground/base/kdeconnect-kde/repository/).
+
+[](https://build.kde.org/job/kdeconnect-kde%20master%20kf5-qt5/)
--
kdeconnect packaging
More information about the pkg-kde-commits
mailing list