Merge branch 'master' of git.labs.intellij.net:idea/community
[idea/community.git] / README.md
1 # IntelliJ IDEA Community Edition
2
3 This is the official GitHub mirror of the [IntelliJ IDEA Community Edition](http://www.jetbrains.com/idea/) source code.
4
5 ## Building
6
7 To develop IntelliJ IDEA, you can use either IntelliJ IDEA Community Edition or IntelliJ IDEA Ultimate. To build and run the code:
8
9 * Make sure you have the Groovy plugin enabled. Parts of IntelliJ IDEA are written in Groovy, and you will get compilation errors if you don't have the plugin enabled.
10 * Make sure you have the UI Designer plugin enabled. Most of IntelliJ IDEA's UI is built using the UI Designer, and the version you build will not run correctly if you don't have the plugin enabled.
11 * Open the directory with the source code as a directory-based project
12 * Configure a JSDK named "IDEA jdk", pointing to an installation of JDK 1.6
13 * On Windows or Linux, add lib\tools.jar from the JDK installation directory to the classpath of IDEA jdk
14 * Use Build | Make Project to build the code
15 * To run the code, use the provided shared run configuration "IDEA".
16
17 ## Contributing
18
19 Pull requests are welcome. Please make sure that you follow the [IntelliJ Coding Guidelines](http://www.jetbrains.org/display/IJOS/IntelliJ+Coding+Guidelines).
20 Note that you'll need to submit a [Contributor Agreement](http://www.jetbrains.org/display/IJOS/Contributor+Agreement) before we can accept your pull request.