/protocols/asn/docs/sources/src/main/resources/en-US/Chapter-Setup.xml

 1<?xml version='1.0'?>
 2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 3<!ENTITY % BOOK_ENTITIES SYSTEM "SS7_Stack_User_Guide.ent">
 4%BOOK_ENTITIES;
 5]>
 6
 7<chapter id="setup">
 8
 9	<title>Setup</title>
10
11<!--	<section id="preinstall_requirements_and_prerequisites">
12		<title>Pre-Install Requirements and Prerequisites</title>
13		<para>Ensure that the following requirements have been met before continuing with the install.</para>
14		<section id="hardware_requirements">
15			<title>Hardware Requirements</title>
16			<para>The Library doesn't change the &THIS.PLATFORM; Hardware Requirements.</para>
17			
18		</section>
19		<section id="software_prerequisites">
20			<title>Software Prerequisites</title>
21			<para>There are no specific software requirements.</para>
22		</section>
23	</section>--><!--Note: The preinstall requirements section is not needed, as the Library doesn't change any of the standard requirements.-->
24	
25	<section id="source_code">
26		<title>&THIS.PLATFORM;  &THIS.APPLICATION; Source Code</title>
27		<para></para>
28		
29		<section id="release_source_building">
30			<title>Release Source Code Building</title>
31			<procedure>
32				<step>
33				    <title>Downloading the source code</title>
34				    <important>
35				    	<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>
36				    </important>
37				    <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>
38				    <programlisting>[usr]$ svn co &THIS.RELEASE_SOURCE_CODE_URL;/&THIS.VERSION; &THIS.APPLICATION.DIRNAME;-&THIS.VERSION;</programlisting>
39  				</step>
40				<step>
41				    <title>Building the source code</title>
42				    <important>
43				    	<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>
44				    </important>
45				    <para>Use Maven to build the binaries.</para>
46				    <programlisting>
47				    [usr]$ cd &THIS.APPLICATION.DIRNAME;-&THIS.VERSION;
48				    [usr]$ mvn install
49				    </programlisting>
50				    <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>
51  				</step>
52			</procedure>      
53		</section>	
54		
55		<section id="trunk_source_building">
56			<title>Development Trunk Source Building</title>
57			<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>
58		</section>	
59		
60	</section>
61
62</chapter>
63