From: Debayan Sutradhar Date: Thu, 25 Feb 2021 18:45:08 +0530 Subject: Merge pull request #24 from j4ckofalltrades/readme-local-dev --- Merge pull request #24 from j4ckofalltrades/readme-local-dev Add README --- --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Stream-Pi Server + +![version](https://img.shields.io/badge/Version-1.0.0-green) + +## Prerequisites + +- Java >= 11 +- Maven >= 3.6.3 + +## 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`