]> git.r.bdr.sh - rbdr/lyricli/blame - README.md
Remove the openssl stuff
[rbdr/lyricli] / README.md
CommitLineData
026a2f69 1# Lyricli (lrc)
bcd37f40 2
255dbbae
BB
3A command line tool to show the lyrics of your current song.
4
5## Usage
6
c53df649 7Lyricli can be invoked with the command `lrc`.
255dbbae
BB
8
9```
10$ lrc [-t]
11```
12
13When you run it without arguments, it will look in the available source
14to try to find a playing song and extract the lyrics. If you include the
15`-t` flag, it will show the song and artist names before the lyrics.
16
17```
18$ lrc [-t] <artist_name> <song_name>
19```
20
21When you run it with arguments, it will use them to search for the
22lyrics. This won't work if you manually disable the arguments source in
23your configuration file. If you include the `-t` flag, it will show the
24song and artist names before the lyrics.
25
26### Commands
27
c53df649 28In order to configure sources, lyricli provides a few commands:
255dbbae 29
c53df649 30* `lrc -l` or `lrc --list-sources` lists the available sources. Enabled
255dbbae 31 sourcess will have a `*`
c53df649
RBR
32* `lrc -e` or `lrc --enable-source <source>` enables a source
33* `lrc -d` or `lrc --disable-source <source>` disables a source without
34 resetting its configuration.
35* `lrc -r` or `lrc --reset-source <source>` resets the configuration
36 for a source and disables it.
37
38And you can print the help or the version:
39
255dbbae
BB
40* `lrc -v` or `lrc --version` prints the version
41* `lrc -h` or `lrc --help` display built-in help
026a2f69
BB
42
43## Building
44
738ec06d
RBR
45In order to build this project, you'll need a genius client token. See
46the [genius api docs][genius_api_docs] for more information.
255dbbae 47
738ec06d
RBR
48The Makefile will read the values from a `.env` file, so you can copy the
49`env.dist` file and fill the values there.
6e949673 50
738ec06d
RBR
51You can build for development just by running make. You can specify the
52profile using the profile environment value `-e profile=release`.
6e949673 53
255dbbae 54```
738ec06d
RBR
55# Build for dev
56make
255dbbae 57
738ec06d
RBR
58# Build for release
59make -e profile=release
255dbbae 60```
22172f7d 61
040b91a7
RBR
62### Additional Dependencies
63
64On linux you might need to install the libssl-dev and libdbus-dev
65
738ec06d 66[genius_api_docs]: https://docs.genius.com/