Add more context on the manual

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

diff --git a/lyricli.gmi b/lyricli.gmi
index 325d33b6f5837d954e480fd3d04cfc84eaba78e4..29ed9bef3a75e4faa166358ee45d8ca04dae66c7 100644 (file)
--- a/lyricli.gmi
+++ b/lyricli.gmi
@@ -1,35 +1,60 @@
 --- title: /lyricli.html
 --- 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)
 
 ## 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.

 
 

-→ <a href="https://git.sr.ht/~rbdr/lyricli">view source</a>.
+=> 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 &amp; Security" in your system settings.
-
-## Install from Homebrew
+## Install

 
 

+### Homebrew

 You can install using homebrew. For direct binaries see below.
 
 ```
 $ brew tap rbdr/apps git@git.sr.ht:~rbdr/homebrew-apps
 $ brew install lyricli
 ```
 You can install using homebrew. For direct binaries see below.
 
 ```
 $ brew tap rbdr/apps git@git.sr.ht:~rbdr/homebrew-apps
 $ brew install lyricli
 ```

-## Download

 
 

-* [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
+### 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.

 
 

-=> /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)
+Binaries are provided for x86_64 and aarch64.

 
 

-## Usage
+Unstable releases are built directly from the main branch, while tagged
+versions have their own release and can be considered more stable.
+
+=> 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
 
 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
 
 ```
 You can run it with artist name and song name to fetch it manually
 
 ```


@@ -66,14 +91,36 @@ $ lrc -l
 $ lrc --list-sources
 ```
 
 $ lrc --list-sources
 ```
 

-## All Versions
+## Manual
+
+If you install using the rpm and deb you should be able to call help with man
+
+```
+man lrc
+```
+
+## 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)
 
 => /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)
 => /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)