Skip to content

A README.md generator operated through the CLI that asks a user for information and generates a README.md document using the data acquired.

Notifications You must be signed in to change notification settings

JD-Rowley/readme-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 

Repository files navigation

README Generator

Table of Contents

Description

This is a README.md file generator designed to ease the burden of creating a README file by asking the user questions and populating the sections accordingly.

Installation

This generator uses the Node.js runtime and Inquirer command line interface. Firstly, Node should be installed followed by the 'npm init' command to prep for Inquirer. Next, Inquirer should be installed using the command 'npm install inquirer.'

Usage

This app is run through the command line, as such, the user merely needs to confirm they are in the correct directory and type either 'node index.js' or 'node index.'

Please view the video at this link to see this app in action:

https://watch.screencastify.com/v/JPf1Y81JmuQSV8dgFZsO

Contribution Guidelines

Contributions are unnecessary at this time.

Testing

This app does not currently have a testing function.

Questions

GitHub Repo: https://github.com/JD-Rowley/readme-generator

About

A README.md generator operated through the CLI that asks a user for information and generates a README.md document using the data acquired.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published