diff options
| author | Ben Beltran <ben@nsovocal.com> | 2017-05-18 23:51:44 -0500 |
|---|---|---|
| committer | Ben Beltran <ben@nsovocal.com> | 2017-05-18 23:51:44 -0500 |
| commit | 255dbbaee3d3d440da1565b913d982372f72479d (patch) | |
| tree | 2837be916a8f25cbd05823d0593269fae9f46ca5 | |
| parent | e17e616e2fa2059ef9cb93b7d654687c15d3cb07 (diff) | |
Add a more detailed readme
| -rw-r--r-- | README.md | 68 |
1 files changed, 65 insertions, 3 deletions
@@ -1,11 +1,73 @@ # Lyricli (lrc) -A command line tool to show the lyrics of your current song +A command line tool to show the lyrics of your current song. + +## Usage + +Lyricli can be invoked with the command `lrc`. It can be invoked without +arguments, with an artist and song or with a special command: + +``` +$ lrc [-t] +``` + +When you run it without arguments, it will look in the available source +to try to find a playing song and extract the lyrics. If you include the +`-t` flag, it will show the song and artist names before the lyrics. + +``` +$ lrc [-t] <artist_name> <song_name> +``` + +When you run it with arguments, it will use them to search for the +lyrics. This won't work if you manually disable the arguments source in +your configuration file. If you include the `-t` flag, it will show the +song and artist names before the lyrics. + +### Commands + +In order to configure + +* `lrc -l` or `lrc --list-sources` lists the available sources. Enabled + sourcess will have a `*` +* `lrc -e` or `lrc --enable <source>` enables a source +* `lrc -d` or `lrc --disable <source>` disables a source +* `lrc -r` or `lrc --reset-source <source>` resets the configuration for + a source and disables it. +* `lrc -v` or `lrc --version` prints the version +* `lrc -h` or `lrc --help` display built-in help ## Building -Run `swift build` +The build has only been tested on OSX using Swift 3.1. Building defaults +to the debug configuration. + +``` +make +``` + +## Installing from source + +Builds lyricli in release configuration and copies the executable as +`lrc` to `/usr/local/bin` + +``` +make install +``` + +### Installing to a custom directory + +This can be done by overriding the `install_path` variable + +``` +make install install_path=/opt/bin +``` ## Running tests -Run `swift test` +No tests at the moment 😬... but the makefile is mapped to run the swift +tests. + +``` +make test +``` |