X-Git-Url: https://git.r.bdr.sh/rbdr/lyricli/blobdiff_plain/f43cbaf08072763aa3abd11736cfc77cd9457637..738ec06d26a2a19bdda8a992d2250e731d954631:/README.md?ds=inline diff --git a/README.md b/README.md index 5614f5d..932cc02 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,7 @@ 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: +Lyricli can be invoked with the command `lrc`. ``` $ lrc [-t] @@ -26,60 +25,38 @@ song and artist names before the lyrics. ### Commands -In order to configure +In order to configure sources, lyricli provides a few commands: -* `lrc -l` or `lrc --list` lists the available sources. Enabled +* `lrc -l` or `lrc --list-sources` lists the available sources. Enabled sourcess will have a `*` -* `lrc -e` or `lrc --enable ` enables a source -* `lrc -d` or `lrc --disable ` disables a source -* `lrc -r` or `lrc --reset ` resets the configuration for - a source and disables it. +* `lrc -e` or `lrc --enable-source ` enables a source +* `lrc -d` or `lrc --disable-source ` disables a source without + resetting its configuration. +* `lrc -r` or `lrc --reset-source ` resets the configuration + for a source and disables it. + +And you can print the help or the version: + * `lrc -v` or `lrc --version` prints the version * `lrc -h` or `lrc --help` display built-in help ## Building -The build has only been tested on OSX using Swift 3.1. Building defaults -to the debug configuration. - -``` -make -``` +In order to build this project, you'll need a genius client token. See +the [genius api docs][genius_api_docs] for more information. -## Installing from source +The Makefile will read the values from a `.env` file, so you can copy the +`env.dist` file and fill the values there. -Builds lyricli in release configuration and copies the executable as -`lrc` to `/usr/local/bin` +You can build for development just by running make. You can specify the +profile using the profile environment value `-e profile=release`. ``` -make install -``` - -### Installing to a custom directory - -This can be done by overriding the `install_path` variable - -``` -make install install_path=/opt/bin -``` - -## Linting and Generating Documentation - -We use [swiftlint][swiftlint] to lint, and `make lint` to run it. -We use [jazzy][jazzy] and [SourceKitten][sourcekitten] to document, and -`make document` to generate it. - -## Running tests - -No tests at the moment 😬... but the makefile is mapped to run the swift -tests. +# Build for dev +make +# Build for release +make -e profile=release ``` -make test -``` - -[![Build Status](https://travis-ci.org/lyricli-app/lyricli.svg?branch=master)](https://travis-ci.org/lyricli-app/lyricli) -[swiftlint]: https://github.com/realm/SwiftLint -[jazzy]: https://github.com/realm/jazzy -[sourcekitten]: https://github.com/jpsim/SourceKitten +[genius_api_docs]: https://docs.genius.com/