X-Git-Url: https://git.r.bdr.sh/rbdr/lyricli/blobdiff_plain/255dbbaee3d3d440da1565b913d982372f72479d..a95769b541e1f6959a11f489e03002d1bc97b7ce:/README.md diff --git a/README.md b/README.md index 2e7545c..5614f5d 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,11 @@ 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 @@ -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 @@ -71,3 +77,9 @@ 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