rome/HowToBuildRome.html

144 lines
6.4 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2013-09-27 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>ROME - How to build Rome?</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="author" content="mkurz" />
<meta name="Date-Creation-yyyymmdd" content="20110814" />
<meta name="Date-Revision-yyyymmdd" content="20130927" />
<meta http-equiv="Content-Language" content="en" />
</head>
<body class="composite">
<div id="banner">
<a href="http://github.com/rometools/" id="bannerLeft">
<img src="images/romelogo.png" alt="ROME" />
</a>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xright">
<span id="publishDate">Last Published: 2013-09-27</span>
&nbsp;| <span id="projectVersion">Version: 1.1-SNAPSHOT</span>
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>Rome</h5>
<ul>
<li class="none">
<a href="index.html" title="Overview">Overview</a>
</li>
<li class="collapsed">
<a href="HowRomeWorks/index.html" title="How Rome Works">How Rome Works</a>
</li>
<li class="none">
<a href="RssAndAtOMUtilitiEsROMEV0.5AndAboveTutorialsAndArticles/index.html" title="Tutorials And Articles">Tutorials And Articles</a>
</li>
<li class="collapsed">
<a href="ROMEReleases/index.html" title="Releases">Releases</a>
</li>
<li class="none">
<a href="ROMEDevelopmentProposals/index.html" title="ROME Development Proposals">ROME Development Proposals</a>
</li>
</ul>
<h5>Project Documentation</h5>
<ul>
<li class="collapsed">
<a href="project-info.html" title="Project Information">Project Information</a>
</li>
<li class="collapsed">
<a href="project-reports.html" title="Project Reports">Project Reports</a>
</li>
</ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<div class="section">
<h2>How to build Rome?<a name="How_to_build_Rome"></a></h2>
<p>Rome is built using mighty <a class="externalLink" href="http://maven.apache.org/">Maven</a>! This is why these instructions are so short:-)</p>
<p>If you don't want to build Rome we'd suggest you download a binary build:-)</p>
<div class="section">
<h3>Check out from Subversion<a name="Check_out_from_Subversion"></a></h3>
<p>See <a class="externalLink" href="https://rometools.jira.com/source/browse/ROME">Version Control</a> for access intructions and to browse the source from your browser.</p>
<p>Check out the tag version-0-1 for version 0.1. Else checkout the trunk for the development version.</p></div>
<div class="section">
<h3>Setup maven<a name="Setup_maven"></a></h3>
<p>See <a class="externalLink" href="http://maven.apache.org/run-maven/index.html">Installing Maven</a> for details.</p>
<p>Maven automatically downloads dependencies of a project from an online repository.</p></div>
<div class="section">
<h3>Build rome.jar<a name="Build_rome.jar"></a></h3>
<p>At the command prompt type:</p>
<div class="source">
<pre>
&gt; mvn jar:jar
</pre></div>
<p>This will build</p>
<div class="source">
<pre>
rome/target/rome-VERSION.jar
</pre></div>
<p>You're good to go.</p>
<div class="section">
<h4>Build a full binary distribution<a name="Build_a_full_binary_distribution"></a></h4>
<div class="source">
<pre>
&gt; mvn
</pre></div></div>
<div class="section">
<h4>Build the project site<a name="Build_the_project_site"></a></h4>
<div class="source">
<pre>
&gt; mvn site
</pre></div></div></div>
<div class="section">
<h3>For Rome developers<a name="For_Rome_developers"></a></h3>
<div class="section">
<h4>Work on Rome using Eclipse<a name="Work_on_Rome_using_Eclipse"></a></h4>
<div class="source">
<pre>
&gt; mvn eclipse:eclipse
</pre></div>
<p>will setup the Eclipse project for you.</p>
<p>We don't use the site:deploy or dist:deploy targets yet since java.net is not very maven-friendly yet:-)</p></div></div></div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">
Copyright &#169; 2004-2013
<a href="http://www.rometools.org">ROME Project</a>.
All Rights Reserved.
</div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>