Added README.md
This commit is contained in:
parent
5cbc272ee3
commit
e7ddf1b7e4
1 changed files with 38 additions and 0 deletions
38
README.md
Normal file
38
README.md
Normal file
|
@ -0,0 +1,38 @@
|
||||||
|
# Wobuzz
|
||||||
|
|
||||||
|
Wobuzz is an audio player made by The Wobbler.
|
||||||
|
Currently it is still in early development and not really usable.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
To install Wobuzz, you firstly have to install the dependencies that can't be installed using pip.
|
||||||
|
This can be done using:
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
sudo apt install pyqt6-dev-tools xcb libxcb-cursor0
|
||||||
|
```
|
||||||
|
|
||||||
|
Now you can just clone the repo and let pip install it.
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
https://teapot.informationsanarchistik.de/Wobbl/Wobuzz.git
|
||||||
|
cd Wobuzz
|
||||||
|
pip install .
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage:
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
usage: wobuzz [-h] [-p PLAYLIST_PATH] [TRACKS ...]
|
||||||
|
|
||||||
|
A music player made by The Wobbler.
|
||||||
|
|
||||||
|
positional arguments:
|
||||||
|
TRACKS Plays audio files the from given paths.
|
||||||
|
|
||||||
|
options:
|
||||||
|
-h, --help show this help message and exit
|
||||||
|
-p PLAYLIST_PATH, --playlist PLAYLIST_PATH
|
||||||
|
Imports a playlist from the given path.
|
||||||
|
|
||||||
|
```
|
Loading…
Add table
Reference in a new issue