intellij-sdk-code-samples/basics/checkout_and_build_community.html
breandan considine c313afb6d6 Update base URL
2016-01-14 20:13:15 -08:00

252 lines
13 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en-US">
<head>
<meta charset="UTF-8">
<title>Check Out And Build Community Edition / IntelliJ Platform SDK DevGuide</title>
<link rel="stylesheet" href="/intellij-sdk-docs/app/css/styles.min.css">
<!-- non-retina iPad pre iOS 7 -->
<link rel="apple-touch-icon" href="/intellij-sdk-docs/apple-touch-icon-72x72.png" sizes="72x72">
<!-- retina iPhone pre iOS 7 -->
<link rel="apple-touch-icon" href="/intellij-sdk-docs/apple-touch-icon-114x114.png" sizes="114x114">
<!-- retina iPad pre iOS 7 -->
<link rel="apple-touch-icon" href="/intellij-sdk-docs/apple-touch-icon-144x144.png" sizes="144x144">
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="/intellij-sdk-docs/apple-touch-icon-precomposed.png">
<!-- normal favicon -->
<link rel="shortcut icon" type="image/x-icon" href="/intellij-sdk-docs/favicon.ico">
<link rel="icon" type="image/png" href="/intellij-sdk-docs/favicon.png">
<link rel="stylesheet" href="/intellij-sdk-docs/styles/styles.css"></head>
<body data-id="basics/checkout_and_build_community">
<div class="wrapper">
<section class="panel _nav">
<header class="panel__header">
<div class="container">
<form class="search-box">
<label for="search-box__input" class="search-box__label">
<input type="text" class="search-box__input" id="search-box__input" placeholder="Search IntelliJ Platform SDK DevGuide">
</label>
<div class="search-box__clear" title="Clear"></div>
</form>
</div>
</header>
<nav class="panel__content">
<div class="container _nav">
<menu class="nav-tree"></menu>
</div>
<div class="container _footer panel__footer">
<p><a href="https://youtrack.jetbrains.com/issues/IJSDK">Send feedback</a></p>
<p>&copy; 2000&ndash;2016 <a href="//www.jetbrains.com">JetBrains</a> s.r.o.<br>
All rights reserved.</p>
</div>
</nav>
</section>
<main class="panel _main" role="main">
<header class="panel__header">
<div class="container">
<h3>IntelliJ Platform SDK DevGuide</h3>
<div class="shortcuts-switcher"><label for="switch-shortcuts">Keymap:</label><select id="switch-shortcuts" class="select _shortcuts" height="1">
<option data-group="primary" value="default" selected>Default</option>
<option data-group="primary" value="default_for_gnome">GNOME</option>
<option data-group="primary" value="default_for_kde">KDE</option>
<option data-group="primary" value="default_for_xwin">XWindow</option>
<option data-group="primary" value="emacs">Emacs</option>
<option data-group="primary" value="jbuilder">JBuilder</option>
<option data-group="primary" value="visual_studio">Visual Studio</option>
<option data-group="primary" value="netbeans_6.5">NetBeans 6.5</option>
<option data-group="primary" value="eclipse">Eclipse</option>
<option data-group="secondary" value="mac_os_x_10.5_">OS X 10.5+</option>
<option data-group="secondary" value="mac_os_x">OS X</option>
<option data-group="secondary" value="eclipse_mac_os_x">OS X Eclipse</option></select>
</div>
<div class="panel-trigger"></div>
</div>
</header>
<section class="panel__content">
<div class="container">
<article class="article" data-shortcut-switcher="false">
<h1>Check Out And Build Community Edition</h1>
<a name="installing-git" class="elem-anchor"></a>
<h2>Installing Git<a href="#installing-git" class="anchor-link"><span></span></a></h2>
<p>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 <a href="https://msysgit.github.io" data-bypass="yes" target="_blank"><span>msys git</span></a> distribution on Windows and <a href="http://code.google.com/p/git-osx-installer/" data-bypass="yes" target="_blank"><span>git-osx-installer</span></a> on Mac.</p>
<a name="checking-out-the-code" class="elem-anchor"></a>
<h2>Checking Out the Code<a href="#checking-out-the-code" class="anchor-link"><span></span></a></h2>
<p>You can check out the code either by using IntelliJ IDEA or from the command line.</p>
<p><strong>Checking out from IntelliJ IDEA:</strong></p>
<ul>
<li>Select <strong>VCS | Checkout from Version Control | Git</strong> from the main menu</li>
<li>In the <strong>Git Repository URL</strong> field, enter <code class="code highlight language-text">git://git.jetbrains.org/idea/community.git</code></li>
</ul>
<p><img src="img/check_out_community.png" alt="Check Out Community" /></p>
<p><strong>Checking out from the command line:</strong></p>
<p>Please execute the following command:</p>
<pre><code class="code-block__wrapper code-block _highlighted lang_text">git clone --depth 1 git://git.jetbrains.org/idea/community.git idea
</code></pre>
<p>The <a href="https://github.com/JetBrains/intellij-community/tree/master" data-bypass="yes" target="_blank"><span>master</span></a> 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:</p>
<table>
<thead>
<tr>
<th>IntelliJ Product version</th>
<th>Branch name/number</th>
</tr>
</thead>
<tbody>
<tr>
<td>15.0.x</td>
<td><a href="https://github.com/JetBrains/intellij-community/tree/143" data-bypass="yes" target="_blank"><span>143</span></a></td>
</tr>
<tr>
<td>14.1.x</td>
<td><a href="https://github.com/JetBrains/intellij-community/tree/141" data-bypass="yes" target="_blank"><span>141</span></a></td>
</tr>
<tr>
<td>14.0.x</td>
<td><a href="https://github.com/JetBrains/intellij-community/tree/139" data-bypass="yes" target="_blank"><span>139</span></a></td>
</tr>
<tr>
<td>13.1.x</td>
<td><a href="https://github.com/JetBrains/intellij-community/tree/135" data-bypass="yes" target="_blank"><span>135</span></a></td>
</tr>
<tr>
<td>13.0.x</td>
<td><a href="https://github.com/JetBrains/intellij-community/tree/133" data-bypass="yes" target="_blank"><span>133</span></a></td>
</tr>
<tr>
<td>12.0.x</td>
<td><a href="https://github.com/JetBrains/intellij-community/tree/123" data-bypass="yes" target="_blank"><span>123</span></a></td>
</tr>
<tr>
<td>11.1.x</td>
<td><a href="https://github.com/JetBrains/intellij-community/tree/117" data-bypass="yes" target="_blank"><span>117</span></a></td>
</tr>
<tr>
<td>11.0.x</td>
<td><a href="https://github.com/JetBrains/intellij-community/tree/nika" data-bypass="yes" target="_blank"><span>nika</span></a></td>
</tr>
<tr>
<td>10.5.x</td>
<td><a href="https://github.com/JetBrains/intellij-community/tree/xena" data-bypass="yes" target="_blank"><span>xena</span></a></td>
</tr>
<tr>
<td>10.0.x</td>
<td><a href="https://github.com/JetBrains/intellij-community/tree/x0x" data-bypass="yes" target="_blank"><span>x0x</span></a></td>
</tr>
<tr>
<td>9.x</td>
<td><a href="https://github.com/JetBrains/intellij-community/tree/maia" data-bypass="yes" target="_blank"><span>maia</span></a></td>
</tr>
</tbody>
</table>
<p>The source code of stable releases of IntelliJ IDEA Community Edition is also available as a tarball:</p>
<ul>
<li><a href="http://download.jetbrains.com/idea/ideaIC-15.0.1-src.tar.bz2" data-bypass="yes" target="_blank"><span>IntelliJ IDEA Community Edition 15.0.1</span></a></li>
<li><a href="http://download.jetbrains.com/idea/ideaIC-14.1.4-src.tar.bz2" data-bypass="yes" target="_blank"><span>IntelliJ IDEA Community Edition 14.1.4</span></a></li>
<li><a href="http://download.jetbrains.com/idea/ideaIC-13.1.6-src.tar.bz2" data-bypass="yes" target="_blank"><span>IntelliJ IDEA Community Edition 13.1.6</span></a></li>
<li><a href="http://download.jetbrains.com/idea/ideaIC-13.0.4-src.tar.bz2" data-bypass="yes" target="_blank"><span>IntelliJ IDEA Community Edition 13.0.4</span></a></li>
<li><a href="http://download.jetbrains.com/idea/ideaIC-12.1.6-src.tar.bz2" data-bypass="yes" target="_blank"><span>IntelliJ IDEA Community Edition 12.1.6</span></a></li>
<li><a href="http://download.jetbrains.com/idea/ideaIC-12.0.4-src.tar.bz2" data-bypass="yes" target="_blank"><span>IntelliJ IDEA Community Edition 12.0.4</span></a></li>
<li><a href="http://download.jetbrains.com/idea/ideaIC-11.1.4-src.tar.bz2" data-bypass="yes" target="_blank"><span>IntelliJ IDEA Community Edition 11.1.4</span></a></li>
<li><a href="http://download.jetbrains.com/idea/ideaIC-11.0.2-src.tar.bz2" data-bypass="yes" target="_blank"><span>IntelliJ IDEA Community Edition 11.0.2</span></a></li>
<li><a href="http://download.jetbrains.com/idea/ideaIC-10.5.4-src.tar.bz2" data-bypass="yes" target="_blank"><span>IntelliJ IDEA Community Edition 10.5.4</span></a></li>
<li><a href="http://download.jetbrains.com/idea/ideaIC-10.0.3-src.tar.bz2" data-bypass="yes" target="_blank"><span>IntelliJ IDEA Community Edition 10.0.3</span></a></li>
<li><a href="http://download.jetbrains.com/idea/ideaIC-9.0.4-src.tar.bz2" data-bypass="yes" target="_blank"><span>IntelliJ IDEA Community Edition 9.0.4</span></a></li>
</ul>
<a name="forking-on-github" class="elem-anchor"></a>
<h2>Forking on GitHub<a href="#forking-on-github" class="anchor-link"><span></span></a></h2>
<p>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.</p>
<p>The GitHub mirror can be found at <a href="https://github.com/JetBrains/intellij-community" data-bypass="yes" target="_blank"><span>https://github.com/JetBrains/intellij-community</span></a>.</p>
<a name="building-and-running-from-the-ide" class="elem-anchor"></a>
<h2>Building and Running from the IDE<a href="#building-and-running-from-the-ide" class="anchor-link"><span></span></a></h2>
<p>To develop plugins and applications on the IntelliJ Platform, you can use either <a href="https://www.jetbrains.com/idea/download/" data-bypass="yes" target="_blank"><span>IntelliJ IDEA Community Edition</span></a> or <a href="https://www.jetbrains.com/idea/download/" data-bypass="yes" target="_blank"><span>IntelliJ IDEA Ultimate</span></a>.</p>
<p><strong>Building and running the code</strong></p>
<ul>
<li>
<p>Make sure you have the <a href="https://plugins.jetbrains.com/plugin/1524" data-bypass="yes" target="_blank"><span>Groovy plugin</span></a> enabled by going to <strong>Settings | Plugins</strong> and enabling <strong>Groovy</strong> plugin checkbox.</p>
<p><img src="img/groovy_plugin_enabled.png" alt="Groovy plugin" /></p>
<p>Parts of IntelliJ IDEA are written in Groovy, and you will get compilation errors if you dont have the plugin enabled.</p>
</li>
<li>
<p>Make sure you have the UI Designer plugin enabled. Most of the IntelliJ IDEA platform UI is built using the UI Designer, and the version you build will not run correctly if you dont have the plugin enabled.</p>
<p><img src="img/ui_designer_plugin_enabled.png" alt="UI Designer plugin" /></p>
</li>
<li>Open the directory with the source code as a directory-based project.</li>
<li>
<p>Configure a Java SDK named <em>IDEA jdk</em> (case sensitive), pointing to an installation of JDK 1.8</p>
<p><img src="img/configure_sdk.png" alt="Configure SDK" /></p>
</li>
<li>
<p>Add <code class="code highlight language-text">lib\\tools.jar</code> from the JDK installation directory to the classpath of IDEA JDK</p>
<p><img src="img/tools_jar.png" alt="tools.jar" /></p>
</li>
<li>Use <strong>Build | Make Project</strong> to build the code.</li>
<li>
<p>To run the code, use the <em>IDEA</em> shared run configuration provided by the project.</p>
<p><img src="img/idea_run_configuration.png" alt="IDEA Run Configuration" /></p>
</li>
</ul>
<a name="building-and-running-from-the-command-line" class="elem-anchor"></a>
<h2>Building and Running from the Command Line<a href="#building-and-running-from-the-command-line" class="anchor-link"><span></span></a></h2>
<p>To build the distribution archive of <em>IntelliJ IDEA Community Edition</em>, execute the <a href="https://upsource.jetbrains.com/idea-ce/file/idea-ce-1731d054af4ca27aa827c03929e27eeb0e6a8366/build.xml" data-bypass="yes" target="_blank"><span>build.xml</span></a> Ant build script in the root directory of the source code.</p>
<p><img src="img/ant_build_xml.png" alt="Execute Ant Build Script" /></p>
<p>The results of the build execution can be found at <em>out/artifacts</em>.</p>
<div class="last-modified">
Last modified: 6 January 2016
</div>
</article>
<section class="disqus">
<div id="disqus_thread"></div>
</section>
</div>
</section>
</main>
</div>
<script data-main="/intellij-sdk-docs/app/js/main.build" data-baseurl="/intellij-sdk-docs/" src="/intellij-sdk-docs/app/js/vendor/requirejs/require.js"></script>
</body>
</html>