Skip to content

Commit

Permalink
reword
Browse files Browse the repository at this point in the history
  • Loading branch information
azuline committed Oct 27, 2023
1 parent ec44b7d commit a9b069f
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 31 deletions.
59 changes: 31 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,43 +136,46 @@ _Demo Video TBD_

# Features

This section contains a concise list of Rosé's features.

- Virtual Filesystem
- Read audio files and cover art
- Modify files and cover art
- Filter releases by album artist, genre, label, and "new"-ness
- Browse and edit collages and playlists
- Group artist aliases together
- Toggle release "new"-ness
- Whitelist/blacklist entries in the artist, genre, and label views
- Command Line
- Edit release metadata as a text file
- Import metadata and cover art from third-party sources
- Extract embedded cover art to a file
- Automatically update metadata via patterns and rules
- Collage and playlist management
- Toggle release "new"-ness
- Create "singles" from tracks (even if currently tagged as part of an album)
- Update the read cache (force update supported)
- Watch the source directory and auto-update the cache on file modification
- Dump library metadata as JSON
**Virtual Filesystem:**

- Read audio files and cover art
- Modify audio files and cover art
- Filter releases by album artist, genre, label, and "new"-ness
- Browse and edit collages and playlists
- Group artist aliases together
- Toggle release "new"-ness
- Whitelist/blacklist entries in the artist, genre, and label views

**Command Line:**

- Edit release metadata as a text file
- Import metadata and cover art from third-party sources
- Extract embedded cover art to a file
- Automatically update metadata via patterns and rules
- Collage and playlist management
- Toggle release "new"-ness
- Create "singles" from tracks (even if currently tagged as part of an album)
- Update the read cache (force update supported)
- Watch the source directory and auto-update the cache on file modification
- Print library metadata as JSON

**General:**

- Support for `.mp3`, `.m4a`, `.ogg` (vorbis), `.opus`, and `.flac` audio
files.

And the following are opinionated decisions that might make this tool
unsuitable for you:
Rosé also makes some opinionated decisions. Please make sure that Rosé's
opinions are acceptable for you:

- Rosé modifies files in the source directory, even as early as the first
library scan. All mutations in Rosé are persisted by writing to the source
directory; Rosé maintains no state of its own outside of the source
directory. This makes Rosé work very poorly with files being seeded as
torrents.
directory. This makes Rosé work very poorly with torrents.
- Rosé expects all releases to be immediate child directories of the
source directory. And Rosé expects that all tracks belong to a "release"
(meaning an album, single, EP, etc.). This means that loose audio files at
the top-level of the source directory will be ignored. This makes Rosé work
very poorly with libraries organized as collections of tracks.
the root of the source directory will be ignored. Thus, Rosé works very
poorly with collections of individual track files.

# Installation

Expand All @@ -182,7 +185,7 @@ Nix Flakes with [this installer](https://github.com/DeterminateSystems/nix-insta
Then, to install Rosé, run:

```bash
$ nix profile install github:azuline/rose#rose
$ nix profile install github:azuline/rose
```

# Quickstart
Expand Down
6 changes: 3 additions & 3 deletions docs/METADATA_MANAGEMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Rosé supports three tag container formats:

- ID3: `.mp3` files
- MP4: `.m4a` files
- Vorbis:`.ogg`, `.opus`, and `.flac` files
- Vorbis: `.ogg`, `.opus`, and `.flac` files

In this section, we will list out the per-container fields that we read/write.
Rosé will only write to a single field for each tag; however, for tags with
Expand Down Expand Up @@ -238,10 +238,10 @@ artists = [

# Metadata Import & Cover Art Downloading

In Development
_In Development_

Sources: Discogs, MusicBrainz, Tidal, Deezer, Apple, Junodownload, Beatport, and fanart.tv

# Rules Engine

In Development
_In Development_

0 comments on commit a9b069f

Please sign in to comment.