X-Git-Url: https://git.r.bdr.sh/rbdr/lyricli/blobdiff_plain/22172f7d09afee10de0329160e0003e0aa9ff7ed..101a6eccd794add1a4b1fcb1c9b0d6ece24d2939:/README.md?ds=inline diff --git a/README.md b/README.md index d3ad9e9..57dff9a 100644 --- a/README.md +++ b/README.md @@ -28,18 +28,18 @@ song and artist names before the lyrics. In order to configure -* `lrc -l` or `lrc --list-sources` lists the available sources. Enabled +* `lrc -l` or `lrc --list` 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-source ` resets the configuration for +* `lrc -r` or `lrc --reset ` 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 -The build has only been tested on OSX using Swift 3.1. Building defaults +The build has only been tested on OSX using Swift 5.0.1. Building defaults to the debug configuration. ``` @@ -63,6 +63,12 @@ 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 @@ -72,4 +78,6 @@ tests. 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