TBD

• Modify settings.gradle
• Replace scm4j/scm4j-template with your actual module name
• Connect repository to travis-ci.org and coveralls.io
  • https://github.com/settings/connections/applications/f244293c729d5066cf27
  • https://github.com/settings/connections/applications/5b064d049aaeb3438e8e

Overview

Solution in few words

Terms

Basic definitions

Installation

How to install the solution

Configuration

How to configure the solution

Usage

How to use the solution (scenarious, who does what and when)

Status & Troubleshooting

• If background tasks run as a part of the solution it must be possible to view their statuses
• If t13g actions are possible they must be described
• If the solution has logging function it must be described

Limitations

Limitations users should be aware of

Under the Hood

How it works: interactions of core classes/modules

Under the Hood: Testing

Ideas of testing