diff --git a/readme.md b/readme.md index ac9627a..1315787 100644 --- a/readme.md +++ b/readme.md @@ -24,7 +24,7 @@ webbyBits.py 1. Place mp3 files in the `sound/` folder 2. Open `databaseGenerator.py` and put your LastFM API key in at the top or at runtime using `-k APIKey` (*optional*) 3. Run `databaseGenerator.py` - * *The `databaseGenerator.py` will index all mp3 files, and save the information to `songDatabase.json`* + * *The `databaseGenerator.py` will index all mp3 files, and save the information to `songDatabase.db`* * *If getting images, this process may take a long time with a large amount of mp3 files* 4. Run `webbyBits.py` * *The port can be customized at runtime using* `-p portNumber` *as an atribute* @@ -50,19 +50,7 @@ These are specific details on each section of the app, and how to use them - Default `"./sound/"` - _This setting might be kinda iffy on Linux. You're on Linux just go and edit it if you have issues_ - ~~__Make certain you only use forward slashes in your directory, even on Windows__~~ I think this should be fine now i'll check later -- `songDatabase.json` stores all the information about each song in this format: -``` -{ - "songDirectory": "./sound/", - "songData": { - "Circus_Fox Szn.mp3": - {"title": "Circus", - "artist": "Fox Szn", - "art": null, - "length": 141} - } -} -``` +- `songDatabase.db` stores all the information about each song in a SQLite database with tables `songs` and `meta` - `webbyBits.py` imports the database, runs all music playing, and accepts all commands from clients - Searches return matching songs - Accepts Play-Pause and Skip commands