update readme
This commit is contained in:
33
README.md
33
README.md
@@ -8,6 +8,15 @@
|
||||
> 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
|
||||
@@ -18,6 +27,30 @@ features in one app. Rip your CDs (or bring your own media files!), auto-organiz
|
||||
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/`)
|
||||
|
||||
Reference in New Issue
Block a user