diff --git a/README.md b/README.md index 145cf5cd..ad68c94e 100644 --- a/README.md +++ b/README.md @@ -1 +1,33 @@ -# Rocket.Chat.Kotlin.SDK \ No newline at end of file +# Rocket.Chat.Kotlin.SDK + +### Setup + +#### Prerequisites +- Use **Java Development Kit 8** . (Don't Use JDK 9 or above that, `kapt` doesn't work with JDK 9+) + + For more information, refer [This Link](https://github.com/android/android-ktx/issues/461#issuecomment-375936653) + + - Preferable IDE : Intellij Idea + + #### Steps + - Fork the project and clone using `git clone https://github.com/YOUR_USERNAME/Rocket.Chat.Kotlin.SDK.git`. + - Open IntelliJ Idea + - **Import Project** (DO NOT DIRECTLY OPEN PROJECT) + - Browse and select Rocket.Chat.Kotlin.Sdk + - Select `Create project from existing sources` and click `Next` + - A list of source files will be presented. `Mark All` source files and click `Next` + - A list of libraries found will be presented. `Mark All` libraries and click `Next` + - A list of modules will be presented. `Mark All` modules and click `Next` + - Select the `JDK Home Path`. If `JAVA_HOME` is set on the machine, it will be automatically picked. **Make sure the version being selected is JDK 8 and not JDK 9+** + - Click `Next` and `Finish` + + You might be presented with this + + ![import_gradle_project](https://user-images.githubusercontent.com/24780524/54627595-c4940f00-4a99-11e9-9525-9aab1e2c80c4.png) + +Do not worry ! Just click `Inport Gradle Project` + - Select `Create separate module per source set` + - Select `Use default gradle wrapper` + - Click `Ok` and let it build. + + Now you are good to go :)