Improve README.md
This commit is contained in:
parent
b7821aebd2
commit
cf0a72c2a7
40
README.md
40
README.md
|
@ -1,14 +1,18 @@
|
|||
# Syncthing Tray
|
||||
|
||||
Qt 5-based tray application for [Syncthing](https://github.com/syncthing/syncthing)
|
||||
|
||||
* Designed to work under any desktop environment with tray icon support
|
||||
* Tested under
|
||||
* Plasma 5
|
||||
* Openbox/qt5ct/Tint2
|
||||
* Cinnamon
|
||||
* Could be shown as regular window if no tray icon support is available
|
||||
* Doesn't require desktop environment specific libraries
|
||||
## Supported platforms
|
||||
* Designed to work under any desktop environment supported by Qt 5 with tray icon
|
||||
support
|
||||
* No desktop environment specific libraries required
|
||||
* Tested under
|
||||
* Plasma 5
|
||||
* Openbox/qt5ct/Tint2
|
||||
* Cinnamon
|
||||
* Windows 10
|
||||
* Can be shown as regular window if tray icon support is not available
|
||||
|
||||
## Features
|
||||
* Provides quick access to most frequently used features but does not intend to replace the official web UI
|
||||
* Check state of directories and devices
|
||||
* Check current traffic statistics
|
||||
|
@ -26,12 +30,18 @@ Qt 5-based tray application for [Syncthing](https://github.com/syncthing/syncthi
|
|||
* Utilizes either Qt WebKit or Qt WebEngine
|
||||
* Can be built without web view support as well (then the web UI is opened in the regular browser)
|
||||
* Allows quickly switching between multiple Syncthing instances
|
||||
* Still under development; the following features are planned
|
||||
* Show currently processed items
|
||||
* Show recently processed items
|
||||
* Improve notification handling
|
||||
|
||||
## Planned features
|
||||
The tray is still under development; the following features are planned:
|
||||
* Show currently processed items
|
||||
* Show recently processed items
|
||||
* Improve notification handling
|
||||
* Create Plasmoid for Plasma 5 desktop
|
||||
* Outsource backend to extra library so it can be shared by regular tray menu
|
||||
and Plasmoid
|
||||
|
||||
## Screenshots
|
||||
|
||||
### Under Openbox/Tint2
|
||||
![Openbox/Tint2](/resources/screenshots/tint2.png?raw=true)
|
||||
|
||||
|
@ -45,7 +55,7 @@ Qt 5-based tray application for [Syncthing](https://github.com/syncthing/syncthi
|
|||
![Web view](/resources/screenshots/webview.png?raw=true)
|
||||
|
||||
## Download / binary repository
|
||||
I will provide packages for Arch Linux and Windows when releasing. For more information checkout my
|
||||
I provide packages for Arch Linux and Windows. For more information checkout my
|
||||
[website](http://martchus.no-ip.biz/website/page.php?name=programming).
|
||||
|
||||
## Build instructions
|
||||
|
@ -58,7 +68,7 @@ The following Qt 5 modules are requried: core network gui widgets svg webenginew
|
|||
* To force usage of Qt WebKit/Qt WebEngine or to disable both add `-DWEBVIEW_PROVIDER=webkit/webengine/none` to the CMake arguments.
|
||||
|
||||
BTW: I still prefer the deprecated Qt WebKit because
|
||||
* I currently don't know how to allow a particular self-signed certificate in Qt WebEngine. (Currently any self-signed certificate is accepted!)
|
||||
* I currently don't know how to allow a particular self-signed certificate in Qt WebEngine. Currently any self-signed certificate is accepted!
|
||||
* Qt WebEngine can not be built with mingw-w64.
|
||||
* Qt WebEngine is more buggy in my experience.
|
||||
* security issues are not a concern because no other website than the Syncthing web UI is shown.
|
||||
* Security issues are not a concern because no other website than the Syncthing web UI is shown.
|
||||
|
|
|
@ -927,7 +927,7 @@ void SyncthingConnection::readErrors()
|
|||
|
||||
// since there seems no event for this data, just request every thirty seconds, FIXME: make interval configurable
|
||||
if(m_keepPolling) {
|
||||
QTimer::singleShot(300/*00*/, Qt::VeryCoarseTimer, this, SLOT(requestErrors()));
|
||||
QTimer::singleShot(30000, Qt::VeryCoarseTimer, this, SLOT(requestErrors()));
|
||||
}
|
||||
break;
|
||||
} case QNetworkReply::OperationCanceledError:
|
||||
|
|
Loading…
Reference in New Issue