Public

Project privacy set to public. By default, its content is available to everyone (authenticated or not). Please note that more restrictive permissions might exist on some items.

client

Clone or download

Merge pull request #39 from j4ckofalltrades/readme-local-dev

Download Browse

Readme local dev

+26 −5
Debayan Sutradhar (rnayabed) 2021-02-25 18:48
GitHub 2021-02-25 18:48
3fd36fb6aa6382893cc2506cc3d417b57e15de61
git #client/3fd36fb6aa6382893cc2506cc3d417b57e15de61

Modified Files

List
Side by side diff
A README.md
+21 −0
--- /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`
M pom.xml
+5 −5
--- 'a/pom.xml'
+++ b/pom.xml
@@ -230,7 +230,7 @@
<issueManagement>
<system>GitHub</system>
- <url>https://github.com/Stream-Pi/util/issues</url>
+ <url>https://github.com/Stream-Pi/client/issues</url>
</issueManagement>
<licenses>
@@ -257,9 +257,9 @@
</developers>
<scm>
- <url>https://github.com/stream-pi/util</url>
- <connection>scm:git:git://github.com/stream-pi/util.git</connection>
- <developerConnection>scm:git:ssh://git@github.com:stream-pi/util.git</developerConnection>
+ <url>https://github.com/stream-pi/client</url>
+ <connection>scm:git:git://github.com/stream-pi/client.git</connection>
+ <developerConnection>scm:git:ssh://git@github.com:stream-pi/client.git</developerConnection>
</scm>
<distributionManagement>
@@ -272,4 +272,4 @@
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
</repository>
</distributionManagement>
-</project>
\ No newline at end of file
+</project>