2.2 KiB
TODO: Fill in information about this product. Make sure to use the product name and external release number, not internal information.
Product
::PRODUCT-NAME
Internal Release Number
::X.Y.Z
Release Date
::YEAR/MONTH/DAY
Customer Support
:: For more information or support, please visit our website or email us at <::support@COMPANY.com>
Introduction
::This document describes how to install and get started with PRODUCT-NAME.
Minimal System Requirements
::System requirements are described in the release notes.
Installation
TODO: Give detailed installation instructions. Make sure to test these instructions by doing them yourself on a target machine.
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.
What other software must be installed first?
::Before you can install this product, you must install the following packages:
How do I install PRODUCT-NAME?
:: Please follow these steps
- ::STEP
- ::STEP
- ::SUB-STEP
- ::STEP
- ::STEP
How can I uninstall PRODUCT-NAME?
- ::STEP
- ::STEP
- ::SUB-STEP
- ::STEP
- ::STEP
What if I encounter problems?
::Please see the troubleshooting section in the FAQ.
Getting Started
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.
How can I run post-install unit tests?
- :Compile the source code by typing "ant"
- :Run unit tests by typing "ant test"
- ::A brief report will be shown on the console
- ::A detailed test report for any failed tests will be in build/test-out.
::How can I quickly get started using PRODUCT-NAME?
- ::STEP
- ::STEP
- ::SUB-STEP
- ::STEP
- ::STEP