add ProjectFileIndex.getInstance(Project) to simplify clients
[idea/community.git] / README.md
1 # IntelliJ IDEA Community Edition
2 ### Building and Running from the IDE
3 To develop IntelliJ IDEA, you can use either IntelliJ IDEA Community Edition or IntelliJ IDEA Ultimate not older than 15.0. To build and run the code:
4 * Run **getPlugins.sh** / **getPlugins.bat** from the project root directory to check out additional modules.
5 * If this git repository is not on 'master' branch you need to checkout the same branches/tags in android and android/tools-base git repositories.
6 * Open the project.
7 * If an error notification about a missing required plugin (e.g. Kotlin) is shown enable or install that plugin.
8 * Configure a JSDK named "**IDEA jdk**" (case sensitive), pointing to an installation of JDK 1.6.
9 * Unless you're running on a Mac with an Apple JDK, add <JDK_HOME>/lib/tools.jar to the set of "**IDEA jdk**" jars.
10 * Configure a JSDK named "**1.8**", pointing to an installation of JDK 1.8.
11 * Add <JDK_18_HOME>/lib/tools.jar to the set of "**1.8**" jars.
12 * Use Build | Build Project to build the code.
13
14 To run the IDE from the built code
15 * use the provided shared run configuration "**IDEA**".
16
17 To run tests apply these setting to the **default** JUnit run configuration type:
18 * Working dir: 
19   `<IDEA_HOME>\bin`
20 * VM parameters: 
21   `-ea -Xbootclasspath/p:../out/classes/production/boot -Xmx128M -Djava.system.class.loader=com.intellij.util.lang.UrlClassLoader -Didea.config.path=../test-config -Didea.system.path=../test-system`
22
23 You can find other useful information at [http://www.jetbrains.org](http://www.jetbrains.org). [Contribute section](http://www.jetbrains.org/display/IJOS/Contribute) of that site describes how you can contribute to IntelliJ IDEA.