X-Git-Url: https://git.r.bdr.sh/rbdr/lyricli/blobdiff_plain/c53df649c817f770ae1750bb6d11113e0bcd2b18..44e7b4de4073e6dc25681bb2fa6977bf5869689a:/README.md diff --git a/README.md b/README.md index 6d6046a..932cc02 100644 --- a/README.md +++ b/README.md @@ -42,45 +42,21 @@ And you can print the help or the version: ## Building -The build has only been tested on OSX using Swift 5.8 Building defaults -to the debug configuration. +In order to build this project, you'll need a genius client token. See +the [genius api docs][genius_api_docs] for more information. -``` -make -``` - -## Installing from source - -Builds lyricli in release configuration and copies the executable as -`lrc` to `/usr/local/bin` - -``` -make install -``` +The Makefile will read the values from a `.env` file, so you can copy the +`env.dist` file and fill the values there. -### Installing to a custom directory +You can build for development just by running make. You can specify the +profile using the profile environment value `-e profile=release`. -This can be done by overriding the `install_path` variable - -``` -make install install_path=/opt/bin ``` +# Build for dev +make -## 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. - -``` -make test +# Build for release +make -e profile=release ``` -[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/