<?xml version="1.0" encoding="UTF-8"?>
|
<!--
|
! CCPL HEADER START
|
!
|
! This work is licensed under the Creative Commons
|
! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
|
! To view a copy of this license, visit
|
! http://creativecommons.org/licenses/by-nc-nd/3.0/
|
! or send a letter to Creative Commons, 444 Castro Street,
|
! Suite 900, Mountain View, California, 94041, USA.
|
!
|
! You can also obtain a copy of the license at legal-notices/CC-BY-NC-ND.txt.
|
! See the License for the specific language governing permissions
|
! and limitations under the License.
|
!
|
! If applicable, add the following below this CCPL HEADER, with the fields
|
! enclosed by brackets "[]" replaced with your own identifying information:
|
! Portions Copyright [yyyy] [name of copyright owner]
|
!
|
! CCPL HEADER END
|
!
|
! Copyright 2013-2015 ForgeRock AS.
|
!
|
-->
|
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
|
<properties>
|
<title>About ${project.name}</title>
|
<author email="opendj-dev@forgerock.org">${project.organization.name}</author>
|
</properties>
|
<body>
|
<section name="About ${project.name}">
|
<p>
|
${project.description}
|
</p>
|
</section>
|
<section name="Documentation for ${project.name}">
|
<p>
|
Javadoc for this module can be found <a href="apidocs/index.html">here</a>.
|
</p>
|
</section>
|
<section name="Get ${project.name}">
|
<p>
|
Start developing your applications by obtaining ${project.name}
|
using any of the following methods:
|
</p>
|
<subsection name="Maven">
|
<p>
|
By far the simplest method is to develop your application using Maven
|
and add the following settings to your <b>pom.xml</b>:
|
</p>
|
<source><repositories>
|
<repository>
|
<id>forgerock-staging-repository</id>
|
<name>ForgeRock Release Repository</name>
|
<url>${mavenRepoReleases}</url>
|
<snapshots>
|
<enabled>false</enabled>
|
</snapshots>
|
</repository>
|
<repository>
|
<id>forgerock-snapshots-repository</id>
|
<name>ForgeRock Snapshot Repository</name>
|
<url>${mavenRepoSnapshots}</url>
|
<releases>
|
<enabled>false</enabled>
|
</releases>
|
</repository>
|
</repositories>
|
|
...
|
|
<dependencies>
|
<dependency>
|
<groupId>${project.groupId}</groupId>
|
<artifactId>${project.artifactId}</artifactId>
|
<version>${project.version}</version>
|
</dependency>
|
</dependencies></source>
|
</subsection>
|
<subsection name="Download">
|
<p>
|
If you are not using Maven then you will need to download a pre-built
|
binary from the ForgeRock Maven repository, along with any compile
|
time <a href="dependencies.html">dependencies</a>:
|
</p>
|
<ul>
|
<li><a href="${mavenRepoReleases}/org/forgerock/opendj/${project.artifactId}">Stable releases</a></li>
|
<li><a href="${mavenRepoSnapshots}/org/forgerock/opendj/${project.artifactId}/${project.version}">Latest development snapshot</a></li>
|
</ul>
|
</subsection>
|
<subsection name="Build">
|
<p>
|
For the DIY enthusiasts you can build it yourself by checking out the
|
latest code using <a href="source-repository.html">Subversion</a>
|
and building it with Maven 3.
|
</p>
|
</subsection>
|
</section>
|
<section name="Getting started">
|
<p>
|
The following example shows how ${project.name} may be used:
|
</p>
|
<source>TODO</source>
|
</section>
|
</body>
|
</document>
|
