en-US.Chapter-Setup.xml Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of restcomm-sctp-docs-sources-restcomm
The newest version!
<?xml version='1.0'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "SCTP_Stack_User_Guide.ent">
%BOOK_ENTITIES;
]>

<chapter id="setup">

	<title>Setup</title>

<!--	<section id="preinstall_requirements_and_prerequisites">
		<title>Pre-Install Requirements and Prerequisites</title>
		<para>Ensure that the following requirements have been met before continuing with the install.</para>
		<section id="hardware_requirements">
			<title>Hardware Requirements</title>
			<para>The Library doesn't change the &THIS.PLATFORM; Hardware Requirements.</para>
			
		</section>
		<section id="software_prerequisites">
			<title>Software Prerequisites</title>
			<para>There are no specific software requirements.</para>
		</section>
	</section>--><!--Note: The preinstall requirements section is not needed, as the Library doesn't change any of the standard requirements.-->
	
	<section id="source_code">
		<title>&THIS.PLATFORM;  &THIS.APPLICATION; Source Code</title>
		<para></para>
		
		<section id="release_source_building">
			<title>Release Source Code Building</title>
			<procedure>
				<step>
				    <title>Downloading the source code</title>
				    <important>
				    	<para>Subversion is used to manage its source code. Instructions for using Subversion, including install, can be found at <ulink url="http://svnbook.red-bean.com" /></para>
				    </important>
				    <para>Use SVN to checkout a specific release source, the base URL is &THIS.RELEASE_SOURCE_CODE_URL;, then add the specific release version, lets consider &THIS.VERSION;.</para>
				    <programlisting>[usr]$ svn co &THIS.RELEASE_SOURCE_CODE_URL;/&THIS.VERSION; &THIS.APPLICATION.DIRNAME;-&THIS.VERSION;</programlisting>
  				</step>
				<step>
				    <title>Building the source code</title>
				    <important>
				    	<para>Maven 2.0.9 (or higher) is used to build the release. Instructions for using Maven2, including install, can be found at <ulink url="http://maven.apache.org" /></para>
				    </important>
				    <para>Use Maven to build the binaries.</para>
				    <programlisting>
				    [usr]$ cd &THIS.APPLICATION.DIRNAME;-&THIS.VERSION;
				    [usr]$ mvn install
				    </programlisting>
				    <para>Once the process finishes you should have the <literal>binary</literal> jar files in the <filename>target</filename> directory of <literal>module</literal>. </para>
  				</step>
			</procedure>      
		</section>	
		
		<section id="trunk_source_building">
			<title>Development Trunk Source Building</title>
			<para>Similar process as for <xref linkend="release_source_building"/>, the only change is the SVN source code URL, which is &THIS.TRUNK_SOURCE_CODE_URL;.</para>
		</section>	
		
	</section>

</chapter>