diff --git a/.attachments/artist-discography.png b/.attachments/artist-discography.png new file mode 100644 index 0000000..23d658d Binary files /dev/null and b/.attachments/artist-discography.png differ diff --git a/.attachments/artists-menu.png b/.attachments/artists-menu.png new file mode 100644 index 0000000..d51488a Binary files /dev/null and b/.attachments/artists-menu.png differ diff --git a/.attachments/favorite-songs.png b/.attachments/favorite-songs.png new file mode 100644 index 0000000..0611056 Binary files /dev/null and b/.attachments/favorite-songs.png differ diff --git a/.attachments/player.png b/.attachments/player.png new file mode 100644 index 0000000..08f7512 Binary files /dev/null and b/.attachments/player.png differ diff --git a/README.md b/README.md new file mode 100644 index 0000000..ff04739 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# SubPy (Name pending) + +SubPy is a terminal user interface (TUI) music player written in Python primarly using the Textual library. SubPy connects to a SubSonic server using the SubSonic API to stream music to your machine. + +# Usage + +## Installation + +Python >= 3.12 + +1. Clone the repo using `git clone` +2. Install dependencies `python -m pip install -r requirements.txt` +3. Set up auth file + +## Auth File + +This program requires a file simply named `auth` that contains your username and password as such `username,password`. + +# Screenshots + +Main View with queue and cover art + +![Main music player view](.attachments/player.png) + +Artists Page + +![![Artists Page](.attachments/artists-menu.png)](.attachments/artists-menu.png) + +![View of an artists discography](.attachments/artist-discography.png) + + +View of favorite songs + +![View of favorited songs](.attachments/favorite-songs.png)