3.2 KiB
3.2 KiB
<html>
<head>
</head>
Overview
Project Plan
Workflows
Current
<!-- Markdown content here -->
<h1 id="user-content-installation--quick-start-guide" dir="auto">Installation / Quick Start Guide</h1>
<hr>
<p dir="auto"><em>TODO: Fill in information about this product. Make sure to use the
<strong>product</strong> name and <strong>external</strong> release number, not internal
information.</em></p>
<h5 id="user-content-product" dir="auto">Product:</h5>
<p dir="auto">::PRODUCT-NAME</p>
<h5 id="user-content-release-number" dir="auto">Release Number:</h5>
<p dir="auto">::X.Y.Z</p>
<h5 id="user-content-release-date" dir="auto">Release Date:</h5>
<p dir="auto">::YEAR/MONTH/DAY</p>
<h5 id="user-content-customer-support" dir="auto">Customer Support:</h5>
<p dir="auto">:: For more information or support, please visit our
<a href="<a href="http://www.COMPANY.com/products/PRODUCTNAME/" class="link">http://www.COMPANY.com/products/PRODUCTNAME/</a>">website</a> or
email us at <a href="mailto:support@COMPANY.com">support@COMPANY.com</a></p>
<hr>
<h3 id="user-content-introduction" dir="auto">Introduction</h3>
<p dir="auto">::This document describes how to install and get started with
PRODUCT-NAME.</p>
<h3 id="user-content-minimal-system-requirements" dir="auto">Minimal System Requirements</h3>
<p dir="auto">::System requirements are described in the <a href="/Suborbital-Systems/ReadySetGit/src/commit/45c9b866b745aef723a4b7d2d7a8e6923894d16e/Release-Notes">release notes</a>.</p>
<h3 id="user-content-installation" dir="auto">Installation</h3>
<p dir="auto"><em>TODO: Give detailed installation instructions. Make sure to test these
instructions by doing them yourself on a target machine.</em></p>
<p dir="auto"><em>TIP: For development releases, or products that are reusable components
rather than end-user applications, you should include information on
needed development and bugging tools, e.g., Ant and JUnit.</em></p>
<h4 id="user-content-what-other-software-must-be-installed-first" dir="auto">What other software must be installed first?</h4>
<p dir="auto">::Before you can install this product, you must install the following
packages:</p>
<ul dir="auto">
<li>::<a href="<a href="http://java.sun.com/" class="link">http://java.sun.com/</a>">Java SDK</a></li>
<li>::<a href="<a href="http://jakarta.apache.org/" class="link">http://jakarta.apache.org/</a>">Apache Tomcat</a></li>
<li>::<a href="<a href="http://mysql.com/" class="link">http://mysql.com/</a>">MySQL database</a></li>
<li>::<a href="http://">OTHER PACKAGES</a></li>
</ul>
<h4 id="user-content-how-do-i-install-product-name" dir="auto">How do I install PRODUCT-NAME?</h4>
<p dir="auto">:: Please follow these steps</p>
<ol dir="auto">
<li>::STEP</li>
<li>::STEP
<ul dir="auto">
<li>::SUB-STEP</li>
</ul>
</li>
<li>::STEP</li>
<li>::STEP</li>
</ol>
<h4 id="user-content-how-can-i-uninstall-product-name" dir="auto">How can I uninstall PRODUCT-NAME?</h4>
<ol dir="auto">
<li>::STEP</li>
<li>::STEP
<ul dir="auto">
<li>::SUB-STEP</li>
</ul>
</li>
<li>::STEP</li>
<li>::STEP</li>
</ol>
<h4 id="user-content-what-if-i-encounter-problems" dir="auto">What if I encounter problems?</h4>
<p dir="auto">::Please see the troubleshooting section in the <a href="/Suborbital-Systems/ReadySetGit/src/commit/45c9b866b745aef723a4b7d2d7a8e6923894d16e/faq.html">FAQ</a>.</p>
<h3 id="user-content-getting-started" dir="auto">Getting Started</h3>
<p dir="auto"><em>TODO: Briefly describe how the user would accomplish one or two of the
main use cases for new users. For development releases or reusable
components, include instructions on running unit tests.</em></p>
<h4 id="user-content-how-can-i-run-post-install-unit-tests" dir="auto">How can I run post-install unit tests?</h4>
<ol dir="auto">
<li>:Compile the source code by typing "ant"</li>
<li>:Run unit tests by typing "ant test"
<ul dir="auto">
<li>::A brief report will be shown on the console</li>
<li>::A detailed test report for any failed tests will be
in build/testout.</li>
</ul>
</li>
</ol>
<h4 id="user-content-how-can-i-quickly-get-started-using-product-name" dir="auto">::How can I quickly get started using PRODUCT-NAME?</h4>
<ol dir="auto">
<li>::STEP</li>
<li>::STEP
<ul dir="auto">
<li>::SUB-STEP</li>
</ul>
</li>
<li>::STEP</li>
<li>::STEP</li>
</ol>
<!-- End Markdown content -->
</html>