From 08feb5ec9b9f83ab99758871f7e4bcad5136c0fc Mon Sep 17 00:00:00 2001 From: Spikatrix <12792882+Spikatrix@users.noreply.github.com> Date: Fri, 3 Jul 2020 10:26:47 +0530 Subject: [PATCH] Added Build Instructions --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e548e38..73ff544 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,21 @@ The game is currently in beta. I've made a [list of work][beta_work] to be done More screenshots are available in the [Google Play Store page][play_store_page] +## Build from source + +If you wish to build from source, clone the repo and run gradle's `android:assembleDebug` and `desktop:dist` tasks for building the Android and Desktop binaries respectively: + + $ git clone https://github.com/Spikatrix/Zoned + $ cd Zoned + $ ./gradlew android:assembleDebug // Android + $ ./gradlew desktop:dist // Desktop + +(Use `gradlew.bat` if you're on Windows) + +You can then find the generated binaries at + - Desktop: `Zoned/desktop/build/libs/*.jar` + - Android: `Zoned/android/build/outputs/apk/debug/*.apk` + ## Contributing Zoned is a FOSS game developed by [me](https://github.com/Spikatrix). I'm available on [Discord][discord_invite] if you want to have a chat with me. @@ -36,7 +51,7 @@ Contributions are always welcome. Here are a few ways you can help: * Report bugs via the [Issue Tracker][issue_tracker] and suggestions via [email][email_feedback] - * Implement new features, cleanup, optimize, refactor and all that good stuff + * Send in pull requests improving the code quality and fixing bugs among others ## License