From e1c38e245a35aad6eec1a9b3e2f8ec0d06aa0b0a Mon Sep 17 00:00:00 2001 From: gyan000 <gyan000@users.noreply.github.com> Date: Mon, 22 Oct 2018 19:18:56 +0200 Subject: [PATCH] Update README.md --- README.md | 62 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 35 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index eb85dde..0d2f397 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ## EOSConnect -It's a KDEConnect client using GTK+ written in Vala, based on mconnect [mconnect](https://github.com/kevinselvaprasanna/mconnect). +It's a KDEConnect client using GTK+ written in Vala, based on [mconnect](https://github.com/kevinselvaprasanna/mconnect). The application is designed for elementary OS. (but should works on other distributions, perhaps.) A note on [mconnect](https://github.com/kevinselvaprasanna/mconnect). First version of EOSConnect used a custom fork of mconnect, extending his DBus API, so used as a backend, started by EOSConnect at startup. But I encoutered lot's of issues with async DBus calls in order to setup mconnect backend correctly, and EOSConnect began to have too much files and abstractions classes - in order to be able to change the backend later. So I decided to integrate directly mconnect code into EOSConnect, removing his DBus API. It removed lot's of code in EOSConnect and I was able to setup and adapt mconnect like I want easily. @@ -9,25 +9,33 @@ A note on [mconnect](https://github.com/kevinselvaprasanna/mconnect). First vers It's a Work In Progess, not intented for daily use. +### Screenshots +#### Main window + + +#### SMS tab + + ### Installation -1 - On Ubuntu or elementary OS, install these dependencies: +1. - On Ubuntu or elementary OS, install these dependencies: ```bash sudo apt install elementary-sdk libunity-dev libnotify-dev libghc-gnutls-dev libsqlite3-dev libedataserver1.2-dev libebook1.2-dev/ -y ``` -2 - Clone the repository. -3 - Inside the project, compile with: +2. - Clone the repository. +3. - Inside the project, compile with: ```bash meson build && clear && ninja -C build && glib-compile-schemas ./data/ ``` -4.1 - To start it from the build directory: +4. Start application + 1. - To start it from the build directory: ```bash GSETTINGS_SCHEMA_DIR=data ./build/src/com.github.gyan000.eos-connect ``` -4.2 - To start it, with complete debug output: + 2. - To start it, with complete debug output: ```bash GSETTINGS_SCHEMA_DIR=data ./build/src/com.github.gyan000.eos-connect -d ``` -5 - To install it: +5. - To install it: ```bash sudo ninja -C build install ``` @@ -59,7 +67,7 @@ sudo ninja -C build install #### v0.4 - notification - [x] Send / receive notifications. - [x] Notification plugin configuration. (configuration window to activate/deactivate send/receive notifications globally and by application, with application filter.) -- [] Synchronise notifications on both devices. (when notification closed on a device, it should close on the other device.) +- [ ] Synchronise notifications on both devices. (when notification closed on a device, it should close on the other device.) #### v0.4 - share - [x] Send one or more files, with popup with file advancement. @@ -75,34 +83,34 @@ sudo ninja -C build install - [x] Widget to send SMS, with input text and dropdown to select available device, which can send a SMS. (to use in the widget send SMS fom header bar, and into the SMS tab.) - [x] When entering phone number or contact name in SMS widget from headerbar, display available contacts, with photo. - [x] Use sqlite3 to store SMS by phone number. (and be able to scroll back in the history) -- [] When user do not want to store SMS with sqlite, use a dummy SMS store. -- [] General option, for all devices, to activate or not the storage of SMS history. -- [] SMS plugin configuration. (to setup how many days of history we want to keep) +- [ ] When user do not want to store SMS with sqlite, use a dummy SMS store. +- [ ] General option, for all devices, to activate or not the storage of SMS history. +- [ ] SMS plugin configuration. (to setup how many days of history we want to keep) #### v0.5.1 - Telephony -- [] Display who's calling, with contact photo if available. -- [] Make sure we display notification when call missed. -- [] Telephony plugin configuration. +- [ ] Display who's calling, with contact photo if available. +- [ ] Make sure we display notification when call missed. +- [ ] Telephony plugin configuration. #### v0.7 - Commands -- [] Execute commands. -- [] Command plugin configuration. (configuration window with available commands for remove device) +- [ ] Execute commands. +- [ ] Command plugin configuration. (configuration window with available commands for remove device) #### v0.8 - Clipboard -- [] Copy / past working. (in both direction ?) -- [] Clipboard plugin configuration. +- [ ] Copy / past working. (in both direction ?) +- [ ] Clipboard plugin configuration. #### v0.9 - Multimedia control -- [] Multimedia control plugin configuration. +- [ ] Multimedia control plugin configuration. #### v0.9.1 - Remote control -- [] Remote control plugin configuration +- [ ] Remote control plugin configuration #### v1 -- [] Remove refresh icon at bottom of devices list. -- [] Unpair device, with icon at bottom of devices list. -- [] Option, when unpairing a device, to delete everything: configuration, SMS history. -- [] Welcome screen, with how-to setup. -- [] Option to setup public visible name of EOSConnect. -- [] Translations: french. -- [] Code cleanup. +- [ ] Remove refresh icon at bottom of devices list. +- [ ] Unpair device, with icon at bottom of devices list. +- [ ] Option, when unpairing a device, to delete everything: configuration, SMS history. +- [ ] Welcome screen, with how-to setup. +- [ ] Option to setup public visible name of EOSConnect. +- [ ] Translations: french. +- [ ] Code cleanup. -- GitLab