Update README.md

This commit is contained in:
simplePCBuilding
2022-10-24 13:36:59 +02:00
committed by GitHub
parent d352e6f555
commit da09fcf0d9

View File

@@ -11,6 +11,20 @@ Yet another Music Player but with one twist. It displays the Playlist beautifull
- Planned: Secondary display app that can run on a different PC in the same network - Planned: Secondary display app that can run on a different PC in the same network
## Installation: ## Installation:
*You may download the compiled version from "releases" and follow the instructions in the "releases" section* *You may download the compiled version from "releases" and follow the instructions in the "releases" section (WINDOWS ONLY)*
- You will need to install the following dependencies: kivy[full], kivymd, pygame. - You will need to install the following dependencies: kivy[full], kivymd, pygame. Additionally, you'll need to install xclip using your distro's package manager.
- 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' - 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'
## Roadmap
**V2.0**
*UPCOMING VERSION IN DEVELOPMENT RIGHT NOW*
- Locked down mode only available when running second app --> Therefore mult-display support / even multi-PC-Support
- Display app can now run on additional PC
- Settings page
- Backend optimisations to reduce CPU loads
- Changing to Pushing instead of polling UI updating
- UI Styling.
POSSIBLE UPDATES:
- Migrate to PyQt5 for Main interface, stay on Kivy for display, as it offers more styling flexibility