From e7ddf1b7e48ae9fb8f4fb3f618889698371d500c Mon Sep 17 00:00:00 2001
From: wobbl <emil@i21k.de>
Date: Sun, 29 Dec 2024 19:27:26 +0100
Subject: [PATCH] Added README.md

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ac72b80
--- /dev/null
+++ b/README.md
@@ -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.
+
+```
\ No newline at end of file