update readme
This commit is contained in:
72
README.md
72
README.md
@@ -4,12 +4,6 @@
|
|||||||
A tray notification application for receiving messages from a [Gotify server](https://github.com/gotify/server).
|
A tray notification application for receiving messages from a [Gotify server](https://github.com/gotify/server).
|
||||||
|
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
<a href="https://github.com/gotify/logo">
|
|
||||||
<img height="370px" src="https://raw.githubusercontent.com/gotify/logo/master/gotify-logo.png" />
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
## Download
|
## Download
|
||||||
|
|
||||||
|
|
||||||
@@ -21,12 +15,32 @@ $ pip install gotify-tray
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Supported Platforms
|
## Features
|
||||||
|
|
||||||
See https://doc.qt.io/qt-6/qsystemtrayicon.html#details
|
- Receive gotify messages in the native notification area.
|
||||||
|
- Reconnect after wake from sleep or losing network connection.
|
||||||
|
- Disable notification banners for low priority messages.
|
||||||
|
- Manually delete received messages.
|
||||||
|
- Go through a history of all previously received messages.
|
||||||
|
|
||||||
|
|
||||||
## Manual Install
|
## Images
|
||||||
|
|
||||||
|
### Notification banners
|
||||||
|
|
||||||
|
Windows 10 | KDE
|
||||||
|
:-------------------------------------------------:|:---------------------------------------------------------:
|
||||||
|
 | 
|
||||||
|
 | 
|
||||||
|
|
||||||
|
### Main window
|
||||||
|

|
||||||
|
|
||||||
|
### Settings window
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
## Manual Installation
|
||||||
|
|
||||||
Get the source and install the requirements:
|
Get the source and install the requirements:
|
||||||
|
|
||||||
@@ -36,12 +50,29 @@ $ cd gotify-tray
|
|||||||
$ pip install -r requirements.txt
|
$ pip install -r requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### Run from source
|
### Run from source
|
||||||
|
|
||||||
```
|
```
|
||||||
$ python -m gotify_tray
|
$ python -m gotify_tray
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Create a pyinstaller executable
|
||||||
|
|
||||||
|
```
|
||||||
|
$ pip install pyinstaller
|
||||||
|
$ pyinstaller gotify-tray.spec
|
||||||
|
```
|
||||||
|
An executable is created at `dist/gotify-tray/`.
|
||||||
|
|
||||||
|
### Inno setup (Windows)
|
||||||
|
|
||||||
|
Create an installer for windows with inno setup from pyinstaller output:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ iscc gotify-tray.iss
|
||||||
|
```
|
||||||
|
|
||||||
### Create and install a pip package
|
### Create and install a pip package
|
||||||
|
|
||||||
- Create the pip package:
|
- Create the pip package:
|
||||||
@@ -59,22 +90,6 @@ $ python -m gotify_tray
|
|||||||
$ gotify-tray
|
$ gotify-tray
|
||||||
```
|
```
|
||||||
|
|
||||||
### Create a pyinstaller executable
|
|
||||||
|
|
||||||
```
|
|
||||||
$ pip install pyinstaller
|
|
||||||
$ pyinstaller gotify-tray.spec
|
|
||||||
```
|
|
||||||
An executable is created at `dist/gotify-tray/`.
|
|
||||||
|
|
||||||
### Inno setup (Windows)
|
|
||||||
|
|
||||||
Create an installer for windows with inno setup from pyinstaller output:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ iscc gotify-tray.iss
|
|
||||||
```
|
|
||||||
|
|
||||||
### Create a deb package
|
### Create a deb package
|
||||||
|
|
||||||
```
|
```
|
||||||
@@ -85,13 +100,6 @@ $ make build
|
|||||||
$ sudo make install
|
$ sudo make install
|
||||||
```
|
```
|
||||||
|
|
||||||
## Images
|
|
||||||
|
|
||||||
Windows 10 | KDE
|
|
||||||
:-------------------------------------------------:|:---------------------------------------------------------:
|
|
||||||
 | 
|
|
||||||
 | 
|
|
||||||
|
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
|
|||||||
BIN
images/main_window.png
Normal file
BIN
images/main_window.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
BIN
images/settings.png
Normal file
BIN
images/settings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
Reference in New Issue
Block a user