add minidocumentation

This commit is contained in:
2024-09-21 22:48:48 +02:00
parent f26529b1a3
commit acaedfe8c7
6 changed files with 33 additions and 1 deletions

20
README.md Normal file
View File

@@ -0,0 +1,20 @@
# osu! PWA player
Website to listen to ur beatmaps and Collections
[https://music.illegalesachen.download/](https://music.illegalesachen.download/)
## Requirements
- [cloudflared](https://github.com/cloudflare/cloudflared/releases/)
- [.net 6.0](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)
## Tutorial
1. Install the Requirements
2. Download the backend, run it and follow the instruction presentend to u in the terminal
3. Login with ur osu account on the Website
4. Add the Website to ur Homescreen
5. Enjoy
### FAQ
- Yes, ur pc needs to run while u want to listen
- How does it work -> [How it works](docs/README.md)
- I dont want to use the website but my own -> hit me up ill help u set it up