From 981fb51af31c6e6f4141521307c1adf4020bc7d2 Mon Sep 17 00:00:00 2001 From: Jonathan Bernard Date: Thu, 21 Apr 2016 08:19:07 -0500 Subject: [PATCH] Added installation/build instructions. --- README.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9b67a9a..18e9eda 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,32 @@ media playback. ## Install -The current version, 0.1.0, is an alpha version. +The current version, 0.1.0, is an alpha version. The CLI client depends on +[VLC](http://www.videolan.org/vlc/) and expects it to already be installed on +the system. -*TODO: installation instructions.* +To install the CLI client: + + $ wget http://mvn.jdb-labs.com/repo/com/jdbernard/wdiwtlt-cli/0.1.0/wdiwtlt-cli-0.1.0.zip + $ unzip wdiwtlt-cli-0.1.0.zip + +The `wdiwtlt-cli` binary is located in `wdiwtlt-cli/bin`, which you can add to +you `PATH` environment variable. + +## Building From Source + +The `wdiwtlt` project is written in [Groovy](http://www.groovy-lang.org/) uses +the [Gradle](http://gradle.org) build tool. If you do not already have a Groovy +environment installed you can do: + + $ curl -s https://get.sdkman.io | bash + $ source "$HOME/.sdkman/bin/sdkman-init.sh" + $ yes | sdkman install groovy + $ yes | sdkman install gradle + +Once you have Groovy and Gradle, the `wdiwtlt` project can be built by invoking +`gradle assembleDist`. + + $ git clone https://git.jdb-labs.com/jdb/wdiwtlt.git + $ cd wdiwtlt + $ gradle assembleDist