aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhannibal2 <24389977+hannibal002@users.noreply.github.com>2023-06-10 16:02:25 +0200
committerGitHub <noreply@github.com>2023-06-10 16:02:25 +0200
commitbce780c722eda5907996bfc0ee31791c3df6c67e (patch)
tree53d2ae210ddf4f9faaa5598a43f54e54acfce40d
parentc5958a0a5b3e0766f67696d0a179847379f87a97 (diff)
downloadskyhanni-bce780c722eda5907996bfc0ee31791c3df6c67e.tar.gz
skyhanni-bce780c722eda5907996bfc0ee31791c3df6c67e.tar.bz2
skyhanni-bce780c722eda5907996bfc0ee31791c3df6c67e.zip
Create CONTRIBUTING.md
-rw-r--r--CONTRIBUTING.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..6de14399a
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,19 @@
+# How to Contribute
+
+This tutorial explains how to set up a development environment to work on SkyHanni. We use [IntelliJ](https://www.jetbrains.com/idea/) as an example.
+
+## Basics
+SkyHanni is a 1.8.9 Forge mod, written in [Kotlin](https://kotlinlang.org/) and [Java](https://www.java.com/en/).
+We use a [gradle config](https://gradle.org/) to build the mod,
+written in [Kotlin DSL](https://docs.gradle.org/current/userguide/kotlin_dsl.html).
+
+This development environment uses [DevAuth](https://github.com/DJtheRedstoner/DevAuth) to allow connecting to Hypixel while debugging in IntelliJ.
+
+## Setup
+
+### Download IntelliJ
+- Download IntelliJ from [JetBrains Website](https://www.jetbrains.com/idea/download/).
+- Use Community Edition.
+- ![image](https://github.com/hannibal002/SkyHanni/assets/24389977/68b9044c-42d0-44ba-85f7-9848a35a27b2)
+
+In Progress - more later