Skip to content

M8MBA/Professional-README-Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Professional README Generator

GitHub license

Description

You can quickly and easily generate a README file by using a command-line application to generate one. This allows you to devote more time to the project.

Table of Contents:

Installation

You must install the following for this app to function:

You must have Node.js installed on your local machine. You can find installation instructions here: https://nodejs.org/en/ . You will also need to install the command line utility which can be found here: https://www.npmjs.com/package/inquirer or by simply typing: npm install inquirer, on the command line.

Usage

Install Node.js

Install inquirer

Invoke the app by running > node index.js in the command line

answer the questions and once you are done a file named generatedREADME.md will be available in the utils folder

Walkthrough Video - https://youtu.be/EVkQgzAXPrQ

Contributors

License MIT

Tests

Run the following commands in your terminal to test this app:

Questions

If you have any questions, please contact me at

or

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published