81 lines
2.3 KiB
Markdown
81 lines
2.3 KiB
Markdown
# Timbre 🐱
|
||
|
||
**a music manager to finally solve this huge mess of music management.**
|
||
|
||
> ⚠️ **Timbre is in extreme alpha.** Right now it can create a library, import
|
||
> and organize your music, scan it, repair itself, and adopt (rip) CDs to
|
||
> tagged, lossless FLAC with cover art. More is planned. It works, but expect
|
||
> rough edges and breaking changes, so use it on music you have backed up
|
||
> elsewhere.
|
||
|
||
## 📑 Contents
|
||
|
||
- [Info](#-info)
|
||
- [Installation](#-installation)
|
||
- [Usage](#️-usage)
|
||
- [Building](#️-building)
|
||
- [The Cat](#-the-cat)
|
||
- [License](#-license)
|
||
|
||
## 📋 Info
|
||
|
||
Currently, ripping CDs, adding metadata, organizing them, playing each, all
|
||
different apps, each with its own problems, own load times, and own opinions.
|
||
Everyone solves this by making workflows, but it's overly inefficient for
|
||
something that should be solved already. Timbre is built to include all of those
|
||
features in one app. Rip your CDs (or bring your own media files!), auto-organize
|
||
them, and play them back in your favorite music player, all with one person's
|
||
opinion instead of tons, seamlessly working, in a fast Rust app.
|
||
|
||
## 📦 Installation
|
||
You will need the following commands on your system for adopting a CD:
|
||
- `cdparanoia`
|
||
- `flac`
|
||
|
||
Here is some ways to get it depending on your system:
|
||
|
||
Arch-based systems
|
||
```
|
||
sudo pacman -S cdparanoia flac
|
||
```
|
||
Debian-based systems
|
||
```
|
||
sudo apt install cdparanoia flac
|
||
```
|
||
Fedora-based systems
|
||
```
|
||
sudo dnf install cdparanoia flac
|
||
```
|
||
|
||
Most are the same, you should be able to figure it out.
|
||
Afterwards, download the binary from the latest release and put it somewhere on path, usually `~/.local/bin/`.
|
||
Then run timbre init and get started.
|
||
|
||
## ⌨️ Usage
|
||
|
||
- `timbre init` - give Timbre a home (`~/Music/Timbre/`)
|
||
- `timbre import` - creates an `Import/` folder, drop music in, run again to organize it
|
||
- `timbre scan` - see what's in your library
|
||
- `timbre repair` - fix a broken library
|
||
|
||
## 🛠️ Building
|
||
|
||
```
|
||
cargo build --release
|
||
```
|
||
|
||
The output will be in `target/release/timbre`
|
||
|
||
Linux only.
|
||
|
||
## 🐈⬛ The Cat
|
||
|
||
Timbre is a bit cat themed, and powered by my cat, CatGPT (`cat_01.jpg`). The cat is not optional. Timbre needs the cat.
|
||
|
||
## 📄 License
|
||
|
||
Public domain ([Unlicense](LICENSE)).
|
||
|
||
---
|
||
|
||
made with 🐈⬛ by [Owen](https://owendeed.com) |