Skip to content

Commit

Permalink
minor doc note additions
Browse files Browse the repository at this point in the history
  • Loading branch information
azuline committed Oct 29, 2023
1 parent d07405b commit 0a0f75f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,11 @@ $ nix profile install github:azuline/rose/master

# Quickstart

> [!NOTE]
> This quickstart assumes you have a local "source directory" of music releases
> for Rosé to manage. Each "release" must be an immediate child subdirectory of
> the "source directory."
Let's now get Rosé up and running!

Once Rosé is installed, let's first confirm that `rose` exists and is
Expand Down
8 changes: 8 additions & 0 deletions docs/METADATA_MANAGEMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,14 @@ delimiter. For example, `genre=Deep House;Techno`. Rosé does not write multiple
frames for a single tag (where each value gets one frame) due to inconsistent
support by other useful programs.

<!-- prettier-ignore-start -->
<!-- prettier removes spaces in between the backticks -->
When reading tags, Rosé is more relaxed in the delimiters it accepts. For the
Genre, Label, Artists, and Album Artists tags, Rosé will attempt to split a
single tag into multiple tags by the following delimiters: ` \\ `, ` / `, `;`,
and ` vs. `.
<!-- prettier-ignore-end -->

## Artist Tags

Rosé preserves the artists' role in the artist tag by using specialized
Expand Down

0 comments on commit 0a0f75f

Please sign in to comment.