Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
devinmorgan committed Oct 20, 2023
1 parent 7f8cab2 commit 8ddd292
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

## Android Studio

This project was developed using Android Studio Electric Eel, but you can also use Android Studio Dolphin since it's currently using Android Gradle Plugin version 7.3.1.
This project was developed using [Android Studio Giraffe](https://developer.android.com/studio/releases), but you can also use Android Studio Hedgehog or Android Studio Iguana since they are also compatible with Android Gradle Plugin (AGP) version 8.1.X.

## Get up and running locally

1. You need to install [the Java Developer Kit (JDK)](https://www.oracle.com/java/technologies/downloads/). The JDK is what powers Android Studio ability to build and run Android apps. Technically, our CI/CD builds Forage Android SDK using [JDK 11](https://github.com/teamforage/forage-android-sdk/blob/f2ff61ed27847b28d631f975c9a79e52f9258802/.github/workflows/CI.yaml#L21). However, as of this writing, the latest stable version is [JDK 17](https://www.oracle.com/java/technologies/downloads/#java17).
1. You need to install [the Java Developer Kit version 17 (JDK 17)](https://www.oracle.com/java/technologies/downloads/#java17). The JDK is what powers Android Studio ability to build and run Android apps. .

> ⚠️ NOTE: Installing the Java Developer Kit (JDK) is **not** the same thing as “[installing Java on your machine](https://www.oracle.com/ca-en/java/technologies/downloads/)”. The latter refers to installing the Java Runtime Environment (JRE), which is what you would install to run a Java application. As we are developing Android applications, we need the JDK, which comes bundled with the JRE as well as other software facilities needed for Java development.
Expand Down

0 comments on commit 8ddd292

Please sign in to comment.