README Generator

Description

An app that can quickly create a professional README for a new project.

Table of Contents

  1. Installation
  2. Usage
  3. Credits
  4. License
  5. Contributing
  6. Questions

Installation

Download the files to your computer. Then open the node.js file in the command line.

Usage

Once the command line is open, run the initial node.js file. Answer the prompts with the relevant information. Once all the prompts have been answered, the README file will be created. An example of this application being used is shown below, it was used to create this README.md.

<iframe src="https://drive.google.com/file/d/1EwWbgiVMwHPVNgdV63_-B_EqBxh9yCYr/preview" width="640" height="480"></iframe>

Credits

This project was finalized with the help of Josh Furlin, the tutor overseeing the development.

License

GNU General Public License v3

Contributing

Please follow the Contributor Covenant guidelines when making any contributions to this project.

Questions?

Please email any questions to ncastledeveloper@gmail.com or find me on Github nikcastle.