MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2025-12-15 02:59:33 +07:00
Code Issues Packages Projects Releases Wiki Activity

platform docs: rework community/README.md (IJSDK-50)

Browse Source
This commit is contained in:
JohnHake
2018-06-29 16:55:41 +03:00
committed by nik
parent 958e7b52ac
commit d63698a533
1 changed files with 65 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
README.md
View File

@@ -1,27 +1,69 @@
# IntelliJ IDEA Community Edition [![official JetBrains project](http://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
### Building and Running from the IDE
To develop IntelliJ IDEA, you can use either IntelliJ IDEA Community Edition or IntelliJ IDEA Ultimate not older than 2017.3. To build and run the code:
* Run **getPlugins.sh** / **getPlugins.bat** from the project root directory to check out additional modules.
* 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.
* Open the project.
* If an error notification about a missing required plugin (e.g. Kotlin) is shown enable or install that plugin.
* Configure a JSDK named "**1.8**", pointing to an installation of JDK 1.8.
* Add <JDK_18_HOME>/lib/tools.jar to the set of "**1.8**" JARs.
* Configure a JSDK named "**IDEA jdk**" (case sensitive), pointing to an installation of JDK 1.6.
* If you don't plan to edit modules which use "IDEA jdk" you can configure "IDEA jdk" to point to the same installation of JDK 1.8 as "1.8" JDK.
* Unless you're running on a Mac with an Apple JDK, add <JDK_HOME>/lib/tools.jar to the set of "**IDEA jdk**" JARs.
* If 'Maven Integration' plugin is disabled add path variable 'MAVEN_REPOSITORY' pointing to '<USER_HOME>/.m2/repository' directory (File | Settings | Appearance & Behavior | Path Variables).
* Use Build | Build Project to build the code.
These instructions will help you build IntelliJ IDEA Community Edition from source code, which is the basis for IntelliJ Platform development. The following conventions will be used to refer to
directories on your machine:
* `<USER_HOME>` is your home directory.
* `<IDEA_HOME>` is the root directory for the IntelliJ source code.
* `<JDK_16_HOME>` is the root directory for the 1.6 JDK, which is optional.
* `<JDK_18_HOME>` is the root directory for the 1.8 JDK.
To run the IDE from the built code
* use the provided shared run configuration "**IDEA**".
## Getting IntelliJ IDEA Community Edition Source Code
IntelliJ IDEA Community Edition source code is available from
`github.com/JetBrains/intellij-community` by either cloning or
downloading a zip file (based on a branch) into `<IDEA_HOME>`. The
default is the *master* branch.
To run tests apply these setting to the **default** JUnit run configuration type:
* Working dir:
`<IDEA_HOME>\bin`
* VM parameters:
`-ea -Xmx128M -Djava.system.class.loader=com.intellij.util.lang.UrlClassLoader -Didea.config.path=../test-config -Didea.system.path=../test-system`
To build an installation packages, run `ant` command in `<IDEA_HOME>` directory. See build.xml file for details.
The master branch contains the source code which will be used to create the next major version of IntelliJ IDEA. The branch names and build numbers for older releases of IntelliJ IDEA can be found on the page of [Build Number Ranges](http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/build_number_ranges.html).
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.
If you intend to make open source contributions to the IntelliJ
Platform, see [Contributing to the IntelliJ Project](http://www.jetbrains.org/display/IJOS/Contribute) for more information.
_**Speed Tip:**_ If the complete repository history isn't
needed then using a shallow clone (`git clone --depth 1`) will save significant time.
These Git operations can also be done through the [IntelliJ IDEA user interface](https://www.jetbrains.com/help/idea/using-git-integration.html).
IntelliJ IDEA Community Edition requires additional Android modules from separate Git repositories. To clone these repositories, run one of the `getPlugins` scripts located in the `<IDEA_HOME>` directory. These scripts clone their respective *master* branches.
* `getPlugins.sh` for Linux or Mac OS.
* `getPlugins.bat` for Windows.
_**Note:**_ Always `git checkout` the `intellij-community`, `android`, and `android/tools-base` Git repositories to the same branches/tags.
## Building IntelliJ Community Edition
Versions 2017.3 and newer of IntelliJ IDEA Community Edition or IntelliJ
IDEA Ultimate Edition are required to build and develop for the IntelliJ
Platform.
### Opening the IntelliJ Source Code for Build
Using IntelliJ IDEA **File | Open**, select the `<IDEA_HOME>` directory.
* If IntelliJ IDEA displays an error about a missing or out of date required plugin (e.g.
Kotlin), [enable, upgrade, or install that plugin](https://www.jetbrains.com/help/idea/managing-plugins.html) and restart IntelliJ IDEA.
* If IntelliJ IDEA displays and error about a Gradle configuration not found,
[refresh the Gradle projects](https://www.jetbrains.com/help/idea/jetgradle-tool-window.html).
### IntelliJ Build Configuration
JDK version 1.8 is required for building and developing for IntelliJ IDEA Community
Edition.
1. Using IntelliJ IDEA, [configure](https://www.jetbrains.com/help/idea/sdk.html) a JSDK
named "**1.8**", pointing to `<JDK_18_HOME>`.
* 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 for the **1.8** JSDK.
2. Also configure a JSDK named "**IDEA jdk**" (case sensitive), pointing to `<JDK_16_HOME>`. If you don’t want to install JDK 1.6 then you may configure **IDEA jdk** to point to `<JDK_18_HOME>`. However, you must be careful to avoid using Java 8 APIs in IntelliJ IDEA Community Edition modules that use **IDEA jdk**.
* If not already present, add the corresponding path for tools.jar to the Classpath for "**IDEA jdk**" JSDK.
3. If the _Maven Integration_ plugin is disabled, [add the path variable](https://www.jetbrains.com/help/idea/working-with-projects.html#path-variables) "**MAVEN_REPOSITORY**" pointing to `<USER_HOME>/.m2/repository` directory.
4. _**Speed Tip:**_ If you have enough RAM on your computer, [configure the compiler settings](https://www.jetbrains.com/help/idea/specifying-compilation-settings.html) to enable the "Compile independent modules in parallel" option. Also set the "User-local build process VM options" to `-Xmx2G`. These changes will greatly reduce the compile time.
### Building the IntelliJ Application Source Code
To build IntelliJ IDEA Community Edition from source, choose **Build | Build Project** from the main menu.
To build installation packages, run the `ant` command in `<IDEA_HOME>` directory. See the `build.xml` file for details.
## Running IntelliJ IDEA
To run the IntelliJ IDEA built from source, choose **Run | Run** from the main menu. This will use the preconfigured run configuration "**IDEA**".
To run tests on the build, apply these setting to the **Run | Edit Run Configurations... | Defaults | JUnit** configuration tab:
* Working dir: `<IDEA_HOME>/bin`
* VM options:
* `-ea`
* `-Djava.system.class.loader=com.intellij.util.lang.UrlClassLoader`
* `-Didea.config.path=../test-config -Didea.system.path=../test-system`
You can find other helpful information at [http://www.jetbrains.org](http://www.jetbrains.org). The [contribute section](http://www.jetbrains.org/display/IJOS/Contribute) of that site describes how you can contribute to IntelliJ IDEA.