blob: a6f3f0c66d77622777033c8a6f64b556184b03bf [file] [log] [blame]
<h1><a name="DeveloperResources-ApacheShiroDeveloperResources"></a>Apache Shiro Developer Resources</h1>
<p>This page and its children are dedicated for reference information used by the Apache Shiro development team when performing tasks as a committer or contributor</p>
<h2><a name="DeveloperResources-WritingDocumentation"></a>Writing Documentation</h2>
<p>All non-JavaDoc documentation is written in our <a class="external-link" href="http://cwiki.apache.org/confluence/display/SHIRO/">Apache Shiro Confluence Wiki Space</a>. This space is converted into the public website by the <a href="confluence-auto-export.html" title="Confluence Auto Export">Confluence Auto Export Process</a>.</p>
<h2><a name="DeveloperResources-SourceCodeRepository"></a>Source Code Repository</h2>
<p>We use a Git repository located at <a class="external-link" href="git://git.apache.org/shiro.git">git://git.apache.org/shiro.git</a>.</p>
<p>Active development is done in the <tt>master</tt> branch, and maintenance typically on the <tt>1.2.x</tt> branch.</p>
<h3><a name="DeveloperResources-BuildingfromGit"></a>Building from Git</h3>
<p>For Shiro cutting-edge development, you can clone the code from Git and build it using <a class="external-link" href="http://maven.apache.org">Maven</a> 2.2+:</p>
<ol><li>Check out the code:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
git clone https:<span class="code-comment">//github.com/apache/shiro.git</span>
</pre>
</div></div></li><li>Build the project using <a class="external-link" href="http://maven.apache.org">Maven</a> 2.2+:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
cd shiro
mvn install
</pre>
</div></div>
<p>The resulting artifacts will be in your local M2 Repo under the org.apache.shiro group.</p></li></ol>
<div class="panelMacro"><table class="warningMacro"><colgroup span="1"><col span="1" width="24"><col span="1"></colgroup><tr><td colspan="1" rowspan="1" valign="top"><img align="middle" src="https://cwiki.apache.org/confluence/images/icons/emoticons/forbidden.gif" width="16" height="16" alt="" border="0"></td><td colspan="1" rowspan="1"><b>Cutting-edge development</b><br clear="none">When building from <tt>master</tt> or any branches, use the generated artifacts at your own risk! Current and previous stable releases will always be available via the <a href="download.html" title="Download">Download</a> page.</td></tr></table></div>