Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #241

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,33 @@
# Rocket.Chat.Kotlin.SDK
# 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`
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo inport -> import

- Select `Create separate module per source set`
- Select `Use default gradle wrapper`
- Click `Ok` and let it build.

Now you are good to go :)