2023-03-24 16:29:16 +00:00
|
|
|
<!-- markdownlint-disable-next-line first-line-h1 -->
|
|
|
|
|
|
|
|
|
|
_TODO: Fill in information about this product. Make sure to use the
|
2018-08-14 21:52:57 +00:00
|
|
|
**product** name and **external** release number, not internal
|
2023-03-24 16:29:16 +00:00
|
|
|
information._
|
2018-08-14 21:52:57 +00:00
|
|
|
|
2021-08-01 13:15:57 +00:00
|
|
|
##### Product
|
2018-08-23 17:23:45 +00:00
|
|
|
|
2018-08-14 21:52:57 +00:00
|
|
|
::PRODUCT-NAME
|
|
|
|
|
|
2021-08-01 13:15:57 +00:00
|
|
|
##### Internal Release Number
|
2018-08-23 17:23:45 +00:00
|
|
|
|
2018-08-14 21:52:57 +00:00
|
|
|
::X.Y.Z
|
|
|
|
|
|
2021-08-01 13:15:57 +00:00
|
|
|
##### Release Date
|
2018-08-23 17:23:45 +00:00
|
|
|
|
2018-08-14 21:52:57 +00:00
|
|
|
::YEAR/MONTH/DAY
|
|
|
|
|
|
2021-08-01 13:15:57 +00:00
|
|
|
##### Customer Support
|
2018-08-23 17:23:45 +00:00
|
|
|
|
2021-08-01 13:15:57 +00:00
|
|
|
:: For more information or support, please visit our
|
|
|
|
|
[website](::http://www.COMPANY.com/products/PRODUCT-NAME/) or
|
|
|
|
|
email us at <::support@COMPANY.com>
|
2018-08-14 21:52:57 +00:00
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### Introduction
|
|
|
|
|
|
|
|
|
|
::This document describes how to install and get started with
|
|
|
|
|
PRODUCT-NAME.
|
|
|
|
|
|
|
|
|
|
### Minimal System Requirements
|
|
|
|
|
|
|
|
|
|
::System requirements are described in the [release notes](Release-Notes).
|
|
|
|
|
|
|
|
|
|
### Installation
|
|
|
|
|
|
2023-03-24 16:29:16 +00:00
|
|
|
_TODO: Give detailed installation instructions. Make sure to test these
|
|
|
|
|
instructions by doing them yourself on a target machine._
|
2018-08-14 21:52:57 +00:00
|
|
|
|
2023-03-24 16:29:16 +00:00
|
|
|
_TIP: For development releases, or products that are reusable components
|
2018-08-14 21:52:57 +00:00
|
|
|
rather than end-user applications, you should include information on
|
2023-03-24 16:29:16 +00:00
|
|
|
needed development and bugging tools, e.g., Ant and JUnit._
|
2018-08-14 21:52:57 +00:00
|
|
|
|
|
|
|
|
#### What other software must be installed first?
|
2018-08-23 17:23:45 +00:00
|
|
|
|
2018-08-14 21:52:57 +00:00
|
|
|
::Before you can install this product, you must install the following
|
|
|
|
|
packages:
|
|
|
|
|
|
|
|
|
|
- ::[Java SDK](http://java.sun.com/)
|
|
|
|
|
- ::[Apache Tomcat](http://jakarta.apache.org/)
|
|
|
|
|
- ::[MySQL database](http://mysql.com/)
|
|
|
|
|
- ::[OTHER PACKAGES](http://)
|
|
|
|
|
|
|
|
|
|
#### How do I install PRODUCT-NAME?
|
2018-08-23 17:23:45 +00:00
|
|
|
|
2018-08-14 21:52:57 +00:00
|
|
|
:: Please follow these steps
|
|
|
|
|
|
|
|
|
|
1. ::STEP
|
|
|
|
|
2. ::STEP
|
|
|
|
|
- ::SUB-STEP
|
|
|
|
|
3. ::STEP
|
|
|
|
|
4. ::STEP
|
|
|
|
|
|
|
|
|
|
#### How can I uninstall PRODUCT-NAME?
|
2018-08-23 17:23:45 +00:00
|
|
|
|
2018-08-14 21:52:57 +00:00
|
|
|
1. ::STEP
|
|
|
|
|
2. ::STEP
|
|
|
|
|
- ::SUB-STEP
|
|
|
|
|
3. ::STEP
|
|
|
|
|
4. ::STEP
|
|
|
|
|
|
|
|
|
|
#### What if I encounter problems?
|
2018-08-23 17:23:45 +00:00
|
|
|
|
2018-08-14 21:52:57 +00:00
|
|
|
::Please see the troubleshooting section in the [FAQ](FAQ).
|
|
|
|
|
|
|
|
|
|
### Getting Started
|
|
|
|
|
|
2023-03-24 16:29:16 +00:00
|
|
|
_TODO: Briefly describe how the user would accomplish one or two of the
|
2018-08-14 21:52:57 +00:00
|
|
|
main use cases for new users. For development releases or reusable
|
2023-03-24 16:29:16 +00:00
|
|
|
components, include instructions on running unit tests._
|
2018-08-14 21:52:57 +00:00
|
|
|
|
|
|
|
|
#### How can I run post-install unit tests?
|
|
|
|
|
|
|
|
|
|
1. :Compile the source code by typing "ant"
|
|
|
|
|
2. :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
|
2018-08-23 17:23:45 +00:00
|
|
|
in build/test-out.
|
2018-08-14 21:52:57 +00:00
|
|
|
|
|
|
|
|
#### ::How can I quickly get started using PRODUCT-NAME?
|
|
|
|
|
|
|
|
|
|
1. ::STEP
|
|
|
|
|
2. ::STEP
|
|
|
|
|
- ::SUB-STEP
|
|
|
|
|
3. ::STEP
|
|
|
|
|
4. ::STEP
|
