Optimize memory traffic for the case when there are some unsaved documents
[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
7 ## Getting IntelliJ IDEA Community Edition Source Code
8 IntelliJ IDEA Community Edition source code is available from `github.com/JetBrains/intellij-community` by either cloning or
9 downloading a zip file (based on a branch) into `<IDEA_HOME>`. The default is the *master* branch. 
10
11 The master branch contains the source code which will be used to create the next major version of IntelliJ IDEA. The branch names
12 and build numbers for older releases of IntelliJ IDEA can be found on the page of
13 [Build Number Ranges](https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html).
14
15 _**Speed Tip:**_ If the complete repository history isn't needed then using a shallow clone (`git clone --depth 1`) will save significant time.
16
17 These Git operations can also be done through the [IntelliJ IDEA user interface](https://www.jetbrains.com/help/idea/using-git-integration.html).
18
19 IntelliJ IDEA Community Edition requires additional Android modules from separate Git repositories. To clone these repositories,
20 run one of the `getPlugins` scripts located in the `<IDEA_HOME>` directory. These scripts clone their respective *master* branches.
21 * `getPlugins.sh` for Linux or macOS.
22 * `getPlugins.bat` for Windows.
23
24 _**Note:**_ Always `git checkout` the `intellij-community` and `android` Git repositories to the same branches/tags. 
25
26 ## Building IntelliJ Community Edition
27 Version 2020.1 or newer of IntelliJ IDEA Community Edition or IntelliJ IDEA Ultimate Edition is required to build and develop
28 for the IntelliJ Platform.
29
30 ### Opening the IntelliJ Source Code for Build
31 Using IntelliJ IDEA **File | Open**, select the `<IDEA_HOME>` directory. 
32 * If IntelliJ IDEA displays an error about a missing or out of date required plugin (e.g. Kotlin),
33   [enable, upgrade, or install that plugin](https://www.jetbrains.com/help/idea/managing-plugins.html) and restart IntelliJ IDEA.
34 * If IntelliJ IDEA displays an error about a Gradle configuration not found,
35   [refresh the Gradle projects](https://www.jetbrains.com/help/idea/jetgradle-tool-window.html). 
36
37 ### IntelliJ Build Configuration
38 1. Configure a JDK named "**corretto-11**", pointing to installation of JDK 11. It's recommended to use Amazon Corretto JDK, but other 
39    distributions based on OpenJDK should work as well. You may [download it directly](https://www.jetbrains.com/help/idea/sdk.html#jdk-from-ide) 
40    from Project Structure dialog.    
41 2. If the _Maven Integration_ plugin is disabled, [add the path variable](https://www.jetbrains.com/help/idea/absolute-path-variables.html)
42    "**MAVEN_REPOSITORY**" pointing to `<USER_HOME>/.m2/repository` directory.
43 3. _**Speed Tip:**_ If you have enough RAM on your computer,
44    [configure the compiler settings](https://www.jetbrains.com/help/idea/specifying-compilation-settings.html)
45    to enable the "Compile independent modules in parallel" option. Also, increase build process heap size:
46    * if you use IntelliJ IDEA 2020.3 or newer, set "User-local build process heap size" to 2048. 
47    * if you use IntelliJ IDEA 2020.2 or older, copy value from "Shared build process VM options" to "User-local build process VM options" and add `-Xmx2G` to it.
48     
49     These changes will greatly reduce compilation time.
50
51 ### Building the IntelliJ Application Source Code
52 To build IntelliJ IDEA Community Edition from source, choose **Build | Build Project** from the main menu.
53
54 To build installation packages, run the `ant` command in `<IDEA_HOME>` directory. See the `build.xml` file for details.
55
56 ## Running IntelliJ IDEA
57 To run the IntelliJ IDEA built from source, choose **Run | Run** from the main menu. This will use the preconfigured run configuration "**IDEA**".
58
59 To run tests on the build, apply these setting to the **Run | Edit Configurations... | Templates | JUnit** configuration tab:
60   * Working dir: `<IDEA_HOME>/bin`
61   * VM options: 
62     * `-ea` 
63     * `-Didea.config.path=../test-config`
64     * `-Didea.system.path=../test-system`
65  
66 You can find other helpful information at [https://www.jetbrains.com/opensource/idea](https://www.jetbrains.com/opensource/idea).
67 The "Contribute Code" section of that site describes how you can contribute to IntelliJ IDEA.