Add wishlist

[rbdr/r.bdr.sh] / lyricli.gmi

diff --git a/lyricli.gmi b/lyricli.gmi
index 455c92caa62dcb1d8dc497203637e55c9d345c45..6da005bb4457bab79f38f145eab664b8fad7f4a9 100644 (file)
--- a/lyricli.gmi
+++ b/lyricli.gmi
@@ -1,15 +1,15 @@
 --- title: /lyricli.html
---- description: "Lyricli (lrc), a command line lyrics finder"
+--- description: "Lyricli (lrc), a command line lyrics finder for linux and mac"
 ## lyricli (lrc)
 
-Command line tool that shows lyrics for your currently playing song in the command line
+Command line tool that shows lyrics for your currently playing song in the terminal, supports spotify and apple music on macos, and most linux music players.
 
-=> https://git.sr.ht/~rbdr/lyricli view source.
+=> https://git.r.bdr.sh/rbdr/lyricli view source (git.r.bdr.sh)
+=> https://git.sr.ht/~rbdr/lyricli view source (sourcehut mirror)
 
-You may need to allow the plugin to run in "Privacy & Security" in your system settings.
-
-## Install from Homebrew
+## Install
 
+### Homebrew
 You can install using homebrew. For direct binaries see below.
 
 ```
@@ -17,20 +17,44 @@ $ brew tap rbdr/apps git@git.sr.ht:~rbdr/homebrew-apps
 $ brew install lyricli
 ```
 
-## Download
+### Prebuilt Packages
+You can find pre-built packages for linux @ build.r.bdr.sh. There you can
+find a `.tar.gz` that includes only the binary, or `.rpm` and `.deb`
+distributions for fedora and debian that include a manpage.
 
-* [1] Latest (2.0.1), for both intel and apple silicon macs (larger binary)
-* [2] Latest (2.0.1), only for apple silicon macs
-* [3] Latest (2.0.1), only for intel macs
+Binaries are provided for x86_64 and aarch64.
 
-=> /files/lyricli/lrc-universal.tar.gz [1] lrc (universal)
-=> /files/lyricli/lrc-arm64.tar.gz [2] lrc (arm64)
-=> /files/lyricli/lrc-x86_64.tar.gz [3] lrc (x86_64)
+Unstable releases are built directly from the main branch, while tagged
+versions have their own release and can be considered more stable.
 
-## Usage
+=> gemini://build.r.bdr.sh/lyricli lyricli pre-built releases @ gemini
+=> https://build.r.bdr.sh/lyricli lyricli pre-built releases @ https
+
+### From Source
+
+In order to build this project, you'll need a genius client token. See the genius api docs for more information.
+
+=> https://docs.genius.com/ genius api docs
+
+Make sure you have rust and Make installed. Clone the repository, and run:
+
+```
+% make -e profile=release
+```
+
+Then copy the file somewhere in your PATH
+
+```
+% cp ./target/release/lyricli /usr/local/lyricli
+```
 
+## Usage
 Running without arguments will try to detect your current song in apple music or spotify
 
+```
+$ lrc
+```
+
 You can run it with artist name and song name to fetch it manually
 
 ```
@@ -44,6 +68,14 @@ $ lrc -h
 $ lrc --help
 ```
 
+### Manual
+
+If you install using the rpm and deb you should be able to call help with man
+
+```
+man lrc
+```
+
 ## Managing Sources
 
 By default it comes with spotify and apple music sources enabled, you can disable sources using:
@@ -67,14 +99,28 @@ $ lrc -l
 $ lrc --list-sources
 ```
 
-## All Versions
+## Changelog
+
+* 3.0.0 Rewritten in rust, supports linux media players. Relicensed to AGPL 3.0
+* 2.0.1 Fixes a segfault when there are no results, and incorrect behavior when results are not songs.
+* 2.0.0 Upgraded for swift 5.8 and work with the genius API instead of defunct LyricsWiki.
+* 1.0.0 Upgraded for swift 5.0. Gets rid of the arguments source. Adds Apple Music support and ensures the app is running.
+* 0.3.0 Spotify support. Bugfixes for iTunes support when app is not running.
+* 0.2.0 iTunes support. Bugfixes for iTunes support when app is not running.
+* 0.1.0 Initial swift release. Relicense to Apache. Only arguments source.
+* 0.0.2 Improves error management and source management. Adds iTunes source.
+* 0.0.1 Initial release in ruby with rdio support.
+
+### Older Releases
+
+You can download binaries of older releases, macos only.
 
-lrc 2.0.1 - Fixes a segfault when there are n1 results, and incorrect behavior when results are not songs.
+2.0.1
 => /files/lyricli/lrc-2.0.1-universal.tar.gz lrc 2.0.1 (universal)
 => /files/lyricli/lrc-2.0.1-arm64.tar.gz lrc 2.0.1 (arm64)
 => /files/lyricli/lrc-2.0.1-x86_64.tar.gz lrc 2.0.1 (x86_64)
 
-lrc 2.0.0 - Rebuilt to use swift 5.8 and work with the genius API instead of defunct LyricsWiki
+2.0.0
 => /files/lyricli/lrc-2.0.0-universal.tar.gz lrc 2.0.0 (universal)
 => /files/lyricli/lrc-2.0.0-arm64.tar.gz lrc 2.0.0 (arm64)
 => /files/lyricli/lrc-2.0.0-x86_64.tar.gz lrc 2.0.0 (x86_64)