Update README and addresses

This commit is contained in:
Jaidyn Ann 2024-01-29 13:42:43 -06:00
parent 7ba34abcf1
commit 741a5d05f6
4 changed files with 56 additions and 53 deletions

54
README.md Normal file
View File

@ -0,0 +1,54 @@
# 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

View File

@ -1,51 +0,0 @@
===============================================================================
WYRICS Git some lyrics
===============================================================================
Fetch lyrics for a song from lyrics.ovh with this script.
This used to use songlyrics.com-- and before that, lyrics.wikia.com.
songlyrics.com has more flexible searching (you could make typos), but it
is a pretty slow site.
lyrics.ovh is a good deal faster, but much more picky.
----------------------------------------
PRE-REQUISITES
----------------------------------------
You'll need:
* curl
* a shell
----------------------------------------
USAGE
----------------------------------------
WYRICS
--------------------
Just run "wyrics" like so:
wyrics $ARTIST $SONG
If you want to save lyrics to a file, you'll need to redirect the
output--
$ wyrics "dream theater" "octavarium" > lyrics.txt
WYDIR
--------------------
Runs "wyrics" over every song in a directory of a given file-extension.
The lyrics are output to "$song.txt"
Just run "wydir" like so:
wydir $ARTIST $FILE_EXTENSION
Convenient if you wanna get the lyrics of an album in one go.
----------------------------------------
BORING STUFF
----------------------------------------
License is CC-0
Author is Jaidyn Ann <jadedctrl@teknik.io>
Sauce is at https://git.feneas.org/detruota/wyrics.git

2
wydir
View File

@ -4,7 +4,7 @@
# desc: run `wyrics` over every song in
# a directory of given file-ext
# main: Jaidyn Ann
# <jadedctrl@teknik.io>
# <jadedctrl@posteo.at>
# lisc: CC 0
########################################

2
wyrics
View File

@ -3,7 +3,7 @@
# name: wyrics
# desc: fetch lyrics from lyrics.ovh
# main: Jaidyn Ann
# <jadedctrl@teknik.io>
# <jadedctrl@posteo.at>
# lisc: CC 0
########################################