Cleanup: NotNull/Nullable
[idea/community.git] / README.md
1 # IntelliJ IDEA Community Edition [![official JetBrains project](http://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
2 These instructions will help you build IntelliJ IDEA Community Edition from source code, which is the basis for IntelliJ Platform development.
3 The following conventions will be used to refer to directories on your machine:
4 * `<USER_HOME>` is your home directory.
5 * `<IDEA_HOME>` is the root directory for the IntelliJ source code.
6 * `<JDK_16_HOME>` is the root directory for the 1.6 JDK, which is optional.
7 * `<JDK_18_HOME>` is the root directory for the 1.8 JDK.
8
9 ## Getting IntelliJ IDEA Community Edition Source Code
10 IntelliJ IDEA Community Edition source code is available from `github.com/JetBrains/intellij-community` by either cloning or
11 downloading a zip file (based on a branch) into `<IDEA_HOME>`. The default is the *master* branch. 
12
13 The master branch contains the source code which will be used to create the next major version of IntelliJ IDEA. The branch names
14 and build numbers for older releases of IntelliJ IDEA can be found on the page of
15 [Build Number Ranges](http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/build_number_ranges.html).
16
17 If you intend to make open source contributions to the IntelliJ Platform,
18 see [Contributing to the IntelliJ Project](http://www.jetbrains.org/display/IJOS/Contribute) for more information.
19
20 _**Speed Tip:**_ If the complete repository history isn't needed then using a shallow clone (`git clone --depth 1`) will save significant time.
21
22 These Git operations can also be done through the [IntelliJ IDEA user interface](https://www.jetbrains.com/help/idea/using-git-integration.html).
23
24 IntelliJ IDEA Community Edition requires additional Android modules from separate Git repositories. To clone these repositories,
25 run one of the `getPlugins` scripts located in the `<IDEA_HOME>` directory. These scripts clone their respective *master* branches.
26 * `getPlugins.sh` for Linux or macOS.
27 * `getPlugins.bat` for Windows.
28
29 _**Note:**_ Always `git checkout` the `intellij-community`, `android`, and `android/tools-base` Git repositories to the same branches/tags. 
30
31 ## Building IntelliJ Community Edition
32 Version 2018.2 or newer of IntelliJ IDEA Community Edition or IntelliJ IDEA Ultimate Edition is required to build and develop
33 for the IntelliJ Platform.
34
35 ### Opening the IntelliJ Source Code for Build
36 Using IntelliJ IDEA **File | Open**, select the `<IDEA_HOME>` directory. 
37 * If IntelliJ IDEA displays an error about a missing or out of date required plugin (e.g. Kotlin),
38   [enable, upgrade, or install that plugin](https://www.jetbrains.com/help/idea/managing-plugins.html) and restart IntelliJ IDEA.
39 * If IntelliJ IDEA displays and error about a Gradle configuration not found,
40   [refresh the Gradle projects](https://www.jetbrains.com/help/idea/jetgradle-tool-window.html). 
41
42 ### IntelliJ Build Configuration
43 JDK version 1.8 (u91 or newer) is required for building and developing for IntelliJ IDEA Community Edition.
44 1. Using IntelliJ IDEA, [configure](https://www.jetbrains.com/help/idea/sdk.html) a JDK named "**1.8**", pointing to `<JDK_18_HOME>`.
45    * If not already present, add `<JDK_18_HOME>/lib/tools.jar` [to the Classpath](https://www.jetbrains.com/help/idea/sdk.html#manage_sdks) tab
46      for the **1.8** JDK.
47 2. Also configure a JDK named "**IDEA jdk**" (case sensitive), pointing to `<JDK_16_HOME>`. If you don’t want to install JDK 1.6
48    then you may configure **IDEA jdk** to point to `<JDK_18_HOME>`. However, you must be careful to avoid using Java 8 APIs
49    in IntelliJ IDEA Community Edition modules that use **IDEA jdk**. 
50    * If not already present, add the corresponding path for tools.jar to the Classpath for "**IDEA jdk**" JDK.
51 3. If the _Maven Integration_ plugin is disabled, [add the path variable](https://www.jetbrains.com/help/idea/working-with-projects.html#path-variables)
52    "**MAVEN_REPOSITORY**" pointing to `<USER_HOME>/.m2/repository` directory.
53 4. _**Speed Tip:**_ If you have enough RAM on your computer,
54    [configure the compiler settings](https://www.jetbrains.com/help/idea/specifying-compilation-settings.html)
55    to enable the "Compile independent modules in parallel" option. Also set the "User-local build process VM options" to `-Xmx2G`.
56    These changes will greatly reduce the compile time.
57
58 ### Building the IntelliJ Application Source Code
59 To build IntelliJ IDEA Community Edition from source, choose **Build | Build Project** from the main menu.
60
61 To build installation packages, run the `ant` command in `<IDEA_HOME>` directory. See the `build.xml` file for details.
62
63 ## Running IntelliJ IDEA
64 To run the IntelliJ IDEA built from source, choose **Run | Run** from the main menu. This will use the preconfigured run configuration "**IDEA**".
65
66 To run tests on the build, apply these setting to the **Run | Edit Run Configurations... | Defaults | JUnit** configuration tab:
67   * Working dir: `<IDEA_HOME>/bin`
68   * VM options: 
69     * `-ea` 
70     * `-Djava.system.class.loader=com.intellij.util.lang.UrlClassLoader` 
71     * `-Didea.config.path=../test-config`
72     * `-Didea.system.path=../test-system`
73  
74 You can find other helpful information at [http://www.jetbrains.org](http://www.jetbrains.org).
75 The [contribute section](http://www.jetbrains.org/display/IJOS/Contribute) of that site describes how you can contribute to IntelliJ IDEA.