Skip to content

Commit

Permalink
rename metadata manager and add a line about it to architecture
Browse files Browse the repository at this point in the history
  • Loading branch information
azuline committed Oct 13, 2023
1 parent f3f5ea0 commit d990f75
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
_Work in Progress. See [Issue #1](https://github.com/azuline/rose/issues/1) for
the current state._

A virtual filesystem music library and a music metadata manager.
A virtual filesystem for music and metadata improvement tooling.

## The Virtual Filesystem Library
## The Virtual Filesystem

Rosé reads a source directory of albums like this:

Expand Down Expand Up @@ -77,7 +77,7 @@ The virtual filesystem constructed from the above source directory is:
└── BLACKPINK - 2016. SQUARE TWO - Single [K-Pop] {YG Entertainment}
```

## The Metadata Manager
## The Metadata Improvement Tooling

Rosé constructs the virtual filesystem from the audio tags. However, audio tags
are frequently missing or incorrect. Thus, Rosé also provides a set of tools to
Expand Down Expand Up @@ -105,7 +105,7 @@ You can install Nix and Nix Flakes with
```
Usage: rose [OPTIONS] COMMAND [ARGS]...
A virtual filesystem music library and a music metadata manager.
A virtual filesystem for music and metadata improvement tooling.
Options:
-v, --verbose Emit verbose logging.
Expand Down Expand Up @@ -236,10 +236,12 @@ Rosé has a simple uni-directional looping architecture.
files. It can always be deleted and fully recreated from source files.
3. The virtual filesystem uses the read cache (for performance). Writes to the
virtual filesystem update the source files and then refresh the read cache.
4. The metadata manager writes to the source files directly, which in turn
refreshes the read cache.

```mermaid
flowchart BT
M[Metadata Manager] -->|Maintains| S
M[Metadata Tooling] -->|Writes| S
S[Source Files] -->|Populates| C
C[Read Cache] -->|Renders| V
V[Virtual Filesystem] -->|Updates| S
Expand Down
2 changes: 1 addition & 1 deletion rose/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class Context:
@click.pass_context
# fmt: on
def cli(cc: click.Context, verbose: bool, config: Path | None = None) -> None:
"""A virtual filesystem music library and a music metadata manager."""
"""A virtual filesystem for music and metadata improvement tooling."""
cc.obj = Context(
config=Config.read(config_path_override=config),
)
Expand Down

0 comments on commit d990f75

Please sign in to comment.