import { FileName } from '../../models/file' ; import { defaultTemplate } from '../default/default.template' ; export function readme ( ) { const fileName = FileName . README ; const fileContent = ( ) : string => { return `# Project Title

## Table of Contents
+ [About](#about)
+ [Getting Started](#getting_started)
+ [Usage](#usage)
+ [Contributing](./CONTRIBUTING.md)

## About <a name = "about"></a>
Write about 1-2 paragraphs describing the purpose of your project.

## Getting Started <a name = "getting_started"></a>
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.

### Prerequisites

What things you need to install the software and how to install them.


### Installing

A step by step series of examples that tell you how to get a development env running.

Say what the step will be

And repeat


End with an example of getting some data out of the system or using it for a little demo.

## Usage <a name = "usage"></a>

Add notes about how to use the system.` ; } ; return defaultTemplate ( fileName , fileContent ( ) ) ; }