X-Git-Url: https://git.r.bdr.sh/rbdr/lyricli/blobdiff_plain/6e94967396373626e5f6ee228fbba5fcb111f3cb..f5a040da21ff2bf594e50d886b5e485cdfdc4a70:/README.md diff --git a/README.md b/README.md index b2c5430..f4d969a 100644 --- a/README.md +++ b/README.md @@ -42,53 +42,25 @@ 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 -``` - -### Configuration - -To avoid storing the API key in source control, clientToken in the -lyrics_engine is using a placeholder value. You'll need to replace this -before building +The Makefile will read the values from a `.env` file, so you can copy the +`env.dist` file and fill the values there. -* `GENIUS_CLIENT_TOKEN`: The Client token for your genius API client - -## Installing from source - -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 +# Build for dev +make +# Build for release +make -e profile=release ``` -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. +### Additional Dependencies -## Running tests - -No tests at the moment 😬... but the makefile is mapped to run the swift -tests. - -``` -make test -``` +On linux you might need to install the libssl-dev and libdbus-dev -[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/