update readme

This commit is contained in:
geoffrey45 2023-02-17 20:44:21 +03:00
parent 146ea4ab4d
commit fb294bf436
2 changed files with 7 additions and 8 deletions

View File

@ -4,12 +4,10 @@
### Make listening to your local music fun again.
`Swing` is a music player for local audio files that is built with both visual coolness and functionality in mind. Just run the app and enjoy your music library in a web browser.
`Swing` is a music player for local audio files built with both visual coolness and functionality in mind. Just run the app and enjoy your music library in a web browser.
> Note: This project is in the early stages of development. Many features are missing but will be added with time.
#### 🎉🎉 Checkout the app screenshots in [this excalidraw canvas](https://excalidraw.com/#json=b52G7e9g-dYhMmcyQy9El,pMWhoENuMZgC6mPgyMmU-g) 🎉🎉.
### Setup
Download the latest release from the [release page](https://github.com/geoffrey45/swingmusic/releases) and launch it. For Linux, you need to make the file executable first.
@ -26,13 +24,15 @@ The app should start at <http://localhost:1970> by default.
Usage: swingmusic [options]
Options:
--build: Build the application
--build: Build the application (in development)
--host: Set the host
--port: Set the port
--no-feat: Do not extract featured artists from the song title
--help, -h: Show this help message
--version, -v: Show the version
--show-feat, -sf: Do not extract featured artists from the song title
--show-prod, -sp: Do not hide producers in the song title
--help, -h: Show this help message
--version, -v: Show the app version
```
### Development

View File

@ -78,7 +78,6 @@ class Track:
self.title = new_title
self.artist_hashes = [utils.create_hash(a, decode=True) for a in artists]
self.artist = [Artist(a) for a in artists]
albumartists = utils.split_artists(self.albumartist)