From: Ben Beltran Date: Fri, 19 May 2017 05:32:30 +0000 (-0500) Subject: Add docs and lint info to readme X-Git-Tag: 0.1.0^2~1^2~8 X-Git-Url: https://git.r.bdr.sh/rbdr/lyricli/commitdiff_plain/259284d03aba0302b1a65cf82bb1fa97535d4ad3?hp=0a349ded18c79cfab18627e48bbd5ddeb21153d1 Add docs and lint info to readme --- diff --git a/README.md b/README.md index d3ad9e9..5e7c995 100644 --- a/README.md +++ b/README.md @@ -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 @@ -73,3 +79,7 @@ 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