/gen-readme

Primary LanguageShell

1. Project title and description

gen-readme: based on Readme-Driven Development. Vaguely geared towards web development.

Generates a README.md file in the current dir with this markdown template.

2. Software requirement

3. Dependencies

N/A

4. Getting started instructions

  • chmod +x gen-readme to make executable
  • move to /usr/local/bin to make globally executable

5. Required configuration

6. Tasks commands

run gen-readme to create this template in the current dir

7. Style Guide

8. Application Architecture

9. Routes/API End Points

10. License information

Use any way you wish.