templates

<Project Name>

<Provide a one sentence description of the purpose of this project.>

• Licence: <The licence under which the project source code is distributed.>
• Language: <The programming language in which the application or library is written.>
• Version: <The version of the latest stable release.>

Introduction

<Provide an introduction to the project explaining in more detail what it is for.>

Examples

<Provide specific examples of use.>

Installation

<Where a binary distribution is availble provide instructions for installing the application (or alternatively, where the binary is a library, provide coordinates for a public artefact repository).>

Build

<Provide instructions for building the application or library from source.>

Known Issues

<Provide details of any known issues with the latest stable release.>

Contributions

<Explain whether third party contributions are accepted and, if so, describe how contributions are accepted, including details of any contributor license agreement that may be required.>