/README-Generator

To quickly create a README file by using a command-line application to generate one. This allow project creator to devote more time to working on project.

Primary LanguageJavaScript

README Generator

Outline a brief description of your project. Live demo here.

Table of Contents

General Information

  • This project is designed to generate a high quality README for an app.
  • What is the purpose of your project? When creating an open source project on Github, it is important to include README. The purpose of creating a README will allow other developers to show their contribution.
  • Why did you undertake it? To quickly create a README file by using a command-line application to generate one. This allow project creator to devote more time to working on project.

Technologies Used

  • Visual Studio
  • Node.js
  • Gitbash

Features

  • Starter Code
  • package.json

Screenshots

Example screenshot

Setup

Project requirements: What are the project requirements/dependencies? Where are they listed? A requirements.txt or a Pipfile.lock file perhaps? Where is it located?

  • A walkthrough video that demonstrates the functionality of the README generator must be submitted, and a link to the video should be included in your README file.
  • A sample README.md file for a project repository generated using your application
  • The URL of the GitHub repository, with a unique name and a README describing the project

Usage

How does one go about using it?

  • To createa README file using command-lines application.

Acknowledgements

Give credit here.

  • This project was inspired by Trilogy Education.
  • Many thanks to Trilogy Education.

Contact

Created by @kabaothao - feel free to contact me!