wyrics/README.md

55 lines
1.5 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Wyrics
Shell script for fetching a songs lyrics from [lyrics.ovh](https://lyrics.ovh).
Previously, this used to use [songlyrics.com](https://songlyrics.com) — and
before that, [lyrics.wikia.com](https://lyrics.wikia.com). At least, until
lyrics.wikia.com was axed for copyright-related reasons.
songlyrics.com had more flexible searching (you could make typos), but it
was a pretty slow site. lyrics.ovh is a good deal faster, but much more picky.
Its also libre, and beautiful.
Check out [lyrics.ovhs repo](https://github.com/NTag/lyrics.ovh)!
## Installation
Simply copy wydir and wyrics into your `$PATH`; somewhere like `/usr/local/bin` or
`~/.local/bin`.
`$ cp wydir wyrics ~/.local/bin/`
## Dependencies
Youll need:
* [curl](https://curl.se)
* Shell (ksh, bash)
## Usage
### Wyrics
Run `wyrics` like so, replacing “$ARTIST” and “$SONG” with your artist and song,
respectively:
`$ wyrics $ARTIST $SONG`
If you want to save lyrics to a file, youll need to redirect the
output:
`$ wyrics "dream theater" "octavarium" > lyrics.txt`
### Wydir
Wydir runs `wyrics` over every song in a directory of a given file-extension.
Each songs lyrics are written to a `.txt` file of the songs name.
Just run `wydir` like so:
`$ wydir $ARTIST $FILE_EXTENSION`
Its convenient if you wanna get the lyrics of an album in one go.
## Meta
License is CC0.
Author is Jaidyn Ann <jadedctrl@posteo.at>
Sauce is at https://hak.xwx.moe/jadedctrl/wyrics