Added installation/build instructions.
This commit is contained in:
parent
bbf8a019f9
commit
981fb51af3
30
README.md
30
README.md
@ -45,6 +45,32 @@ media playback.
|
|||||||
|
|
||||||
## Install
|
## 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
|
||||||
|
Loading…
Reference in New Issue
Block a user