updated readme
This commit is contained in:
50
README.md
Normal file
50
README.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# 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, and repair itself. Everything else, CD
|
||||
> ripping, automatic tagging, and more, is the planned future of the project.
|
||||
|
||||
## 📋 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.
|
||||
|
||||
## ⌨️ 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)).
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
*made with 🐈⬛ by [owendeed.com](https://owendeed.com)*
|
||||
|
||||
</div>
|
||||
Reference in New Issue
Block a user