hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 02:07:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

IJSDK-50: remove checkout_and_build_community instructions and point to intellij-community/README.md instead.

Browse Source
This commit is contained in:
JohnHake 2018-06-27 15:38:16 -07:00
parent a2ed7573b2
commit c2df569b3e
5 changed files with 8 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
_SUMMARY.md
View File

@ -19,7 +19,7 @@
* [Publishing Your Plugin](tutorials/build_system/deployment.md)
* [Using DevKit](basics/getting_started/using_dev_kit.md)
* [Setting Up a Development Environment](basics/getting_started/setting_up_environment.md)
* [Check Out And Build Community Edition](basics/checkout_and_build_community.md)
* [Check Out And Build Community Edition](https://github.com/JetBrains/intellij-community/blob/master/README.md)
* [Creating a Plugin Project](basics/getting_started/creating_plugin_project.md)
* [Creating an Action](basics/getting_started/creating_an_action.md)
* [Running and Debugging a Plugin](basics/getting_started/running_and_debugging_a_plugin.md)

103
basics/checkout_and_build_community.md
View File

@ -1,103 +0,0 @@
---
title: Check Out And Build Community Edition
---
## Installing Git
The source code of IntelliJ IDEA Community Edition is stored in a Git repository. Therefore, in order to check out the sources, you need to have Git installed. We recommend using the [Git for Windows](http://gitforwindows.org/) distribution on Windows and [git-osx-installer](http://code.google.com/p/git-osx-installer/) on Mac.
## Checking Out the Code
You can check out the code either by using IntelliJ IDEA or from the command line.
**Checking out from IntelliJ IDEA:**
* Select **VCS \| Checkout from Version Control \| Git** from the main menu
* In the **Git Repository URL** field, enter `git://git.jetbrains.org/idea/community.git`
![Check Out Community](img/check_out_community.png)
**Checking out from the command line:**
Please execute the following command:
```
git clone --depth 1 git://git.jetbrains.org/idea/community.git idea
```
The [master](https://github.com/JetBrains/intellij-community/tree/master) branch currently contains the code for the most recent development version of IntelliJ IDEA. Source code of older releases of IntelliJ IDEA can be found in the following branches (see [Build Number Ranges](/basics/getting_started/build_number_ranges.md) for more details on branch and build numbers):
| IntelliJ Product version | Branch name/number |
|--------------------------|-------------------------------------------------------------------|
| 2017.3 | [173](https://github.com/JetBrains/intellij-community/tree/173) |
| 2017.2 | [172](https://github.com/JetBrains/intellij-community/tree/172) |
| 2017.1 | [171](https://github.com/JetBrains/intellij-community/tree/171) |
| 2016.3 | [163](https://github.com/JetBrains/intellij-community/tree/163) |
| 2016.2 | [162](https://github.com/JetBrains/intellij-community/tree/162) |
| 2016.1 | [145](https://github.com/JetBrains/intellij-community/tree/145) |
| 15.0.x | [143](https://github.com/JetBrains/intellij-community/tree/143) |
| 14.1.x | [141](https://github.com/JetBrains/intellij-community/tree/141) |
| 14.0.x | [139](https://github.com/JetBrains/intellij-community/tree/139) |
| 13.1.x | [135](https://github.com/JetBrains/intellij-community/tree/135) |
| 13.0.x | [133](https://github.com/JetBrains/intellij-community/tree/133) |
| 12.0.x | [123](https://github.com/JetBrains/intellij-community/tree/123) |
| 11.1.x | [117](https://github.com/JetBrains/intellij-community/tree/117) |
| 11.0.x | [nika](https://github.com/JetBrains/intellij-community/tree/nika) |
| 10.5.x | [xena](https://github.com/JetBrains/intellij-community/tree/xena) |
| 10.0.x | [x0x](https://github.com/JetBrains/intellij-community/tree/x0x) |
| 9.x | [maia](https://github.com/JetBrains/intellij-community/tree/maia) |
The source code of stable releases of IntelliJ IDEA Community Edition is also available as a tarball:
- [IntelliJ IDEA Community Edition 2017.1](https://github.com/JetBrains/intellij-community/archive/idea/171.3780.107.tar.gz)
- [IntelliJ IDEA Community Edition 2016.1.4](https://download.jetbrains.com/idea/ideaIC-2016.1.4-src.tar.bz2)
- [IntelliJ IDEA Community Edition 15.0.6](https://download.jetbrains.com/idea/ideaIC-15.0.6-src.tar.bz2)
- [IntelliJ IDEA Community Edition 14.1.7](https://download.jetbrains.com/idea/ideaIC-14.1.7-src.tar.bz2)
- [IntelliJ IDEA Community Edition 13.1.7](https://download.jetbrains.com/idea/ideaIC-13.1.7-src.tar.bz2)
- [IntelliJ IDEA Community Edition 13.0.5](https://download.jetbrains.com/idea/ideaIC-13.0.5-src.tar.bz2)
- [IntelliJ IDEA Community Edition 12.1.8](https://download.jetbrains.com/idea/ideaIC-12.1.8-src.tar.bz2)
- [IntelliJ IDEA Community Edition 12.0.4](https://download.jetbrains.com/idea/ideaIC-12.0.4-src.tar.bz2)
- [IntelliJ IDEA Community Edition 11.0.2](https://download.jetbrains.com/idea/ideaIC-11.0.2-src.tar.bz2)
- [IntelliJ IDEA Community Edition 10.5.4](https://download.jetbrains.com/idea/ideaIC-10.5.4-src.tar.bz2)
- [IntelliJ IDEA Community Edition 10.0.3](https://download.jetbrains.com/idea/ideaIC-10.0.3-src.tar.bz2)
- [IntelliJ IDEA Community Edition 9.0.4](https://download.jetbrains.com/idea/ideaIC-9.0.4-src.tar.bz2)
## Forking on GitHub
As an alternative to checking out the official repository, you can fork the GitHub mirror of the IntelliJ Platform source code, make changes in your own fork, and send us a pull request.
The GitHub mirror can be found at [https://github.com/JetBrains/intellij-community](https://github.com/JetBrains/intellij-community).
## Building and Running from the IDE
To develop plugins and applications on the IntelliJ Platform, you can use either [IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/download/) or [IntelliJ IDEA Ultimate](https://www.jetbrains.com/idea/download/). Note that this requires 15.0 or later.
**Building and running 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 "IDEA jdk" (case sensitive), pointing to an installation of JDK 1.8.
![Configure SDK](img/configure_sdk.png)
* Unless you're running on a Mac with an Apple JDK, add `/lib/tools.jar` to the set of "IDEA jdk" jars.
![tools.jar](img/tools_jar.png)
* Configure a JSDK named "1.8", pointing to an installation of JDK 1.8.
* Add `/lib/tools.jar` to the set of "1.8" jars.
* Use **Build \| Make Project** to build the code.
* To run the code, use the provided shared run configuration "IDEA".
![IDEA Run Configuration](img/idea_run_configuration.png)
## Building and Running from the Command Line
To build the distribution archive of *IntelliJ IDEA Community Edition*, execute the [build.xml](upsource:///build.xml) Ant build script in the root directory of the source code.
![Execute Ant Build Script](img/ant_build_xml.png)
The results of the build execution can be found at *out/artifacts*.

2
basics/getting_started.md
View File

@ -14,7 +14,7 @@ In this section:
* [Publishing Your Plugin](/tutorials/build_system/deployment.md)
* [Developing plugins using DevKit](getting_started/using_dev_kit.md)
* [Setting Up a Development Environment](getting_started/setting_up_environment.md)
* [Check Out And Build Community Edition](basics/checkout_and_build_community.md)
* [Check Out And Build Community Edition](https://github.com/JetBrains/intellij-community/blob/master/README.md)
* [Creating a Plugin Project](getting_started/creating_plugin_project.md)
* [Creating an Action](getting_started/creating_an_action.md)
* [Running and Debugging a Plugin](getting_started/running_and_debugging_a_plugin.md)

11
basics/getting_started/setting_up_environment.md
View File

@ -6,17 +6,16 @@ title: Setting Up a Development Environment
Use the following check list to ensure that you are ready to develop your custom plugins.
- **IntelliJ IDEA** version 9.0 or later (either Community Edition or Ultimate) must be installed on your computer.
- **IntelliJ IDEA CE source code** should be checked out to your local computer. This is not a requirement but will make it much easier for you to debug your plugins. For detailed instructions, refer to [Check Out And Build Community Edition](/basics/checkout_and_build_community.md).
- **Plugin DevKit** plugin must be enabled in IDE
- **IntelliJ Platform SDK** must be configured for your IDEA project. For more information, see [Configuring IntelliJ Platform SDK](#configuring-intellij-platform-sdk) below.
- **IntelliJ IDEA CE source code** should be checked out to your local computer. This is not a requirement but will make it much easier for you to debug your plugins. For detailed instructions, refer to [Check Out And Build Community Edition](https://github.com/JetBrains/intellij-community/blob/master/README.md).
- **Plugin DevKit** plugin must be [enabled in IntelliJ IDEA](https://www.jetbrains.com/help/idea/managing-plugins.html)
- **IntelliJ Platform SDK** must be configured for your IDEA project. For more information, see below.
### Configuring IntelliJ Platform SDK
To set up your plugin development environment:
* Check out the source code of IntelliJ IDEA Community Edition as described in
[Check Out And Build Community Edition](/basics/checkout_and_build_community.md).
[Check Out And Build Community Edition](https://github.com/JetBrains/intellij-community/blob/master/README.md).
* Create a new *IntelliJ Platform SDK* under **File \| Project Structure**:
@ -26,7 +25,7 @@ To set up your plugin development environment:
![Set Home Directory](img/set_home_directory.png)
* Select the **IDEA jdk** created in [Check Out And Build Community Edition](/basics/checkout_and_build_community.md) as the default Java SDK:
* Select the **IDEA jdk** created in [Check Out And Build Community Edition](https://github.com/JetBrains/intellij-community/blob/master/README.md) as the default Java SDK:
![Set IDEA JDK](img/set_java_sdk.png)

2
basics/getting_started/using_dev_kit.md
View File

@ -8,7 +8,7 @@ own build system. It provides its own SDK type and a set of actions for building
In this section:
* [Setting Up a Development Environment](setting_up_environment.md)
* [Check Out And Build Community Edition](../checkout_and_build_community.md)
* [Check Out And Build Community Edition](https://github.com/JetBrains/intellij-community/blob/master/README.md)
* [Creating a Plugin Project](creating_plugin_project.md)
* [Creating an Action](creating_an_action.md)
* [Running and Debugging a Plugin](running_and_debugging_a_plugin.md)