From d990f7556365a601cc5e982fa9c90f80e1ae9ea3 Mon Sep 17 00:00:00 2001 From: blissful Date: Fri, 13 Oct 2023 12:16:13 -0400 Subject: [PATCH] rename metadata manager and add a line about it to architecture --- README.md | 12 +++++++----- rose/__main__.py | 2 +- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 84c08d6..1ff0fa0 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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 @@ -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. @@ -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 diff --git a/rose/__main__.py b/rose/__main__.py index 54f2c3d..94dfbe2 100644 --- a/rose/__main__.py +++ b/rose/__main__.py @@ -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), )