Standard README

[micey969]

Title: Standardised README
Author: @micey969
Status: Draft
Type: Informational

Abstract

Providing documentation standards.

Motivation

To ensure we have proper documentation of the work we are doing, as well as have one standard when documenting such work. For example, making sure all project repos have a README file and those files would follow a particular format.
This is to ensure we can clearly understand and stay up to date with whatever project others may be working on and what has been done.

Specification

There can be a template drafted for all the documents that are used by the team. These documents should have a clear and understandable layout. Below is a template example for the README file.

Project Title
A short description of what the project is.

Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites
What software you would need to get the project up and running

eg.
	- node
	- sass
	- grunt
(If a specific version is required, please specify)
Setup
A step by step guide to setting up the project on your machine. This can include any configuration or dependency installs.

eg.
	- git clone repo
	- cd repo
	- npm install
(Please be clear for those who are not as tech savvy)
Running the tests
Explain how to run the automated tests for this project.

Contributing
Please read Workflow_Issues_and_Pull_Requests.md for details on the process for submitting pull requests to the project.

Versioning
If there are files that require their version tags to be updated, please indicate. Also, please note how your versioning tags should increment.

Who Do I Talk To?
Names of persons most familiar with the project

Other templates could be found here