update readme

This commit is contained in:
dries.k
2022-09-04 11:06:13 +02:00
parent ca666772b4
commit ae2562cf8f
4 changed files with 78 additions and 74 deletions

64
BUILDING.md Normal file
View File

@@ -0,0 +1,64 @@
## Get the source and install the requirements:
```shell
$ git clone https://github.com/seird/gotify-tray.git
$ cd gotify-tray
$ pip install -r requirements.txt
```
### Run from source
```shell
$ python -m gotify_tray
```
### Create a pyinstaller executable
```shell
$ pip install pyinstaller
$ pyinstaller gotify-tray.spec
```
An executable is created at `dist/gotify-tray/`.
### Create a macos .app
```shell
$ pip install pyinstaller Pillow
$ pyinstaller gotify-tray.spec
```
### Inno setup (Windows)
Create an installer for windows with inno setup from pyinstaller output:
```shell
$ iscc gotify-tray.iss
```
### Create and install a pip package
- Create the pip package:
```shell
$ python -m build
```
- Install the pip package:
```shell
$ pip install dist/gotify_tray-0.1.14-py3-none-any.whl
```
- Launch:
```shell
$ gotify-tray
```
### Create a deb package
```shell
$ make build
# or install
$ sudo make install
```

View File

@@ -4,15 +4,21 @@
A tray notification application for receiving messages from a [Gotify server](https://github.com/gotify/server).
## Download
## Getting started
[Download the latest release.](https://github.com/seird/gotify-tray/releases/latest)
- [Download the latest release.](https://github.com/seird/gotify-tray/releases/latest)
or, install via pip:
```
$ pip install gotify-tray
```
- or, install via pip:
```shell
$ pip install gotify-tray
```
- or, run from source:
```shell
$ pip install -r requirements.txt
$ python -m gotify_tray
```
## Features
@@ -41,77 +47,11 @@ Windows 10 | KDE
![settings](https://raw.githubusercontent.com/seird/gotify-tray/master/images/settings.png)
## Manual Installation
## Build instructions
Get the source and install the requirements:
```
$ git clone https://github.com/seird/gotify-tray.git
$ cd gotify-tray
$ pip install -r requirements.txt
```
### Run from source
```
$ python -m gotify_tray
```
### Create a pyinstaller executable
```
$ pip install pyinstaller
$ pyinstaller gotify-tray.spec
```
An executable is created at `dist/gotify-tray/`.
### Create a macos .app
```
$ pip install pyinstaller Pillow
$ pyinstaller gotify-tray.spec
```
### 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 the pip package:
```
$ python -m build
```
- Install the pip package:
```
$ pip install dist/gotify_tray-0.1.14-py3-none-any.whl
```
- Launch:
```
$ gotify-tray
```
### Create a deb package
```
$ make build
# or install
$ sudo make install
```
See [BUILDING](BUILDING.md).
## Requirements
- python >=3.8
- PyQt6
- requests
- websocket-client

Binary file not shown.

Before

Width:  |  Height:  |  Size: 41 KiB

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 32 KiB