From 0b8b433cd525f4ea3128179529feba47b19c1c89 Mon Sep 17 00:00:00 2001 From: lucaspatenaude Date: Fri, 21 Nov 2025 13:45:06 -0700 Subject: [PATCH] Update README.md --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f66a730..e547065 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,14 @@ This is because the user has no uploaded music inside of the player. ## 📦 2. Setting Up a Music Directory +> [!WARNING] +> In order for your music to correctly show in the player the naming scheme must be followed exactly. Deviating from the naming format given below will lead to errors in how the music data presents itself. Deviating from the directory scheme will lead to information in the wrong places and possibly total failure for the media to show + ### 🗃️ 2a. Create a Directory to Hold Album Files +> [!NOTE] +> Anytime brackets are used in the instructions they are to be disregarded. They are just used to denote a parameter + In order to add music to the player the user must first create a folder that will act as an album/playlist with a specific naming convention. This is done to correctly categorize/sort playlists by artist and to keep audio files isolated to their correct place. `[ARTIST_NAME]/[ALBUM_NAME]/` @@ -38,16 +44,14 @@ The first is `Artwork.jpg` (`.jpeg` & `.png` also work), which is an image file The second type it needs and you may add as many as needed are `.mp3` and `.flac`, which are both audio file types. These files represent the songs in the playlist and should be named with the following convention to ensure the correct ordering: -`01. [SONG_NAME]` --> `02. [NEXT_SONG]` --> ... +`01. [SONG_1_NAME]` --> `02. [SONG_2_NAME]` --> ... --> `99. [SONG_99_NAME]` -> [!NOTE] -> The player will automatically remove the numbering from the front of the audio files using regex. +> [!WARNING] +> The numbering is needed for sorting purposes. Failure to add numbering will lead to tracks being out of order -> [!TIP] -> For example, Dark Side of the Moon has the following song list: -> -> ``` +Here's an example of naming scheme in action in Finder using [Dark Side of the Moon](https://en.wikipedia.org/wiki/The_Dark_Side_of_the_Moon#Track_listing) + ### 🔈 3. Adding the Album to the Music Player