mr_tesla/discover-desktop
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

- Editing the most read readme I've ever written

Browse source
This commit is contained in:
trigg 2020-09-26 22:43:21 +01:00
parent 275bcd1d4c
commit d3e20c983e
1 changed files with 4 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -7,35 +7,24 @@ Considerably lighter on system resources and less hack-and-slash included than d
## Installing
```
git clone https://github.com/trigg/Discover.git
cd Discover
sudo bash install.sh
python3 -m pip install discover-overlay
```
## Dependencies
Requirements should be handled by pip.
Requires PyGTK3, websocket_client
A compositor is strongly advised but there is a non-compositor mode optionally
```
python3 -m pip install websocket_client
```
## Usage
run `discover-overlay`
run `discover-overlay` if this fails it is most likely in `~/.local/bin/discord-overlay`
Comes with sane-enough defaults but has a system tray icon & settings window if needed.
## Updating
Navigate to location of installation
```
git pull
sudo bash install.sh
```
## Still in progress
Not all features are at the level I would like.