From: Debayan Sutradhar Date: Thu, 25 Feb 2021 18:48:32 +0530 Subject: Merge pull request #39 from j4ckofalltrades/readme-local-dev --- Merge pull request #39 from j4ckofalltrades/readme-local-dev Readme local dev --- --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Stream-Pi Client + +![version](https://img.shields.io/badge/Version-1.0.0-green) + +## Prerequisites + +- Java >= 11 +- Maven >= 3.6.3 + +Note: If compiling the Android binary (apk) then Graalvm 21.x JDK should be used. + +## Quick Start + +This project depends on the following Stream-Pi modules: + +- [Stream-Pi Action API](https://github.com/stream-pi/actionapi) +- [Stream-Pi Theme API](https://github.com/stream-pi/themeapi) +- [Stream-Pi Utilities](https://github.com/stream-pi/util) + + +Build and run using `mvn clean javafx:run` --- 'a/pom.xml' +++ b/pom.xml @@ -230,7 +230,7 @@ GitHub - https://github.com/Stream-Pi/util/issues + https://github.com/Stream-Pi/client/issues @@ -257,9 +257,9 @@ - https://github.com/stream-pi/util - scm:git:git://github.com/stream-pi/util.git - scm:git:ssh://git@github.com:stream-pi/util.git + https://github.com/stream-pi/client + scm:git:git://github.com/stream-pi/client.git + scm:git:ssh://git@github.com:stream-pi/client.git @@ -272,4 +272,4 @@ https://oss.sonatype.org/service/local/staging/deploy/maven2/ - \ No newline at end of file +