wonderbeyond
11/8/2017 - 7:44 AM

A README template for new project

A README template for new project

MAPE (Most Awesome Project Ever)

A Simple Description here...


Philosophy

  • Keep simple and concentrated
  • Focus on high performance and scalability

Getting Started

Installation, basic usage etc.

Prerequisites

  • Python 3.5+

Dev Guide

How to contribute etc.

Testing

How to running test cases etc.

Deployment

Deploy releases to production etc.

Operations

Details about production maintenance etc.