<TODO: Repository Name>

<TODO: Repository Description>. In this template file, all text to be replaced is delimited by <TODO: ...>.

Contents

1. Quick Start
2. License
3. Supported Platforms
4. Definitions
5. Functionality
6. Docker Images
7. Dependencies
8. Support

Quick Start

Setup and Activate are required to begin using this repository. Before running these scripts, please make sure that all Dependencies have been cloned.

Setup

Setup installs/unpacks tools used during development activities and locates its repository dependencies (if any). Setup must be run on your machine after cloning the repository or after changing the file location of repositories that it depends upon (if any).

Linux	Setup.sh
Windows	Setup.cmd
Windows (PowerShell)	Setup.ps1

Activate

Activate prepares the current environment for development activities and must be run at least once in each terminal window.

Linux	Activate.sh <TODO: Update configurations>
Windows	Activate.cmd <TODO: Update configurations>
Windows (PowerShell)	Activate.ps1 <TODO: Update configurations>

License

<TODO: Update for your repo>

This repository is licensed under the Boost Software License.

GitHub describes this license as:

A simple permissive license only requiring preservation of copyright and license notices for source (and not binary) distribution. Licensed works, modifications, and larger works may be distributed under different terms and without source code.

This repository distributes the following software:

Software	License
Python	PSF License Agreement

Supported Platforms

<TODO: Update for your repo>

This software has been verified on the following platforms.

Platform	Scripting Environment	Version
Windows	Cmd.exe	Windows 10 April 2018 Update
Windows	PowerShell	Windows 10 April 2018 Update
Linux	Bash	Ubuntu 18.04, 16.04

Definitions

<TODO: Update for your repo>

Term 1

Definition

Term 2

Definition

Functionality

<TODO: Update for your repo>

Feature 1

Description

Feature 2

Description

Docker Images

Docker images of this repository are generated with updates.

<TODO: Update for your repo>

Dependencies

<TODO: Update for your repo>

This repository is dependent upon these repositories.

Repo Name	Description
Common Environment	Common development activities

Related Repositories

Repo Name	Description
Common Environment	Common development activities

Support

For question or issues, please visit <TODO: Your url>.