diff --git a/README.md b/README.md new file mode 100644 index 0000000..a179597 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# MusicPlayer +Yet another Music Player but with one twist. It displays the Playlist beautifully on a second display. + +FEATURES +- Play back music +- Show the playing song on a special screen that also displays the upcoming songs +- Add a file (songlist.csv) into the folder containing the songs, that has the following layout: Songname, Artist, Dance/Music-Style, Tempo +- Multiple Keyboard-Shortcuts are available: Spacebar = Play/Pause; Escape = go back; S = Switch to showcase-screen; Left-arrow-key = previous song; Up-Arrow-Key = Rewind; Right-arrow-key = Next song +- Planned: App theming + +Installation: +- You will need to install the following dependencies: kivy[full], kivymd, pygame. +- Kivy may actually also (if you are on a distro that uses apt) be installed by cloning an apt repository as follows (adapted from kivy documentation), as pip will most likely fail: 'sudo add-apt-repository ppa:kivy-team/kivy', then running 'sudo apt-get update' and then 'sudo apt-get install python3-kivy' diff --git a/bin/gui/gui.kv b/bin/gui/gui.kv index 54257e2..4a620f2 100644 --- a/bin/gui/gui.kv +++ b/bin/gui/gui.kv @@ -1,7 +1,7 @@ RootScreen: Home: Main: - ShowcaseS + ShowcaseS: ########### # POPUPS @@ -218,4 +218,4 @@ RootScreen: name: "Settings" md_bg_color: app.theme_cls.accent_color ToggleButton: - text: "Songinfo = Filename" \ No newline at end of file + text: "Songinfo = Filename"