Skip to content

BeKind-Rewind/the_golden_readme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The Golden README

Description

The Golden README is a README.md generator to facilitate a more efficient use of time so the user can make sure to include all of the important bits in the README and focus more time on the project.

Table of Contents

Usage

The Golden README is a README.md generator that prompts the user to answer pertinent topics and populates appropriate sections of the readme. The newly generated readme will write to the README.md file located in the sample folder.

Users initiate the app from the terminal of the repository's root directory with command "node index". User will the be prompted to answer questions which will be used to dynamically create or rewrite the README.md file in the sample folder.

Screeenshot

alt text

Video Demo URL

https://drive.google.com/file/d/1eWEFtfEjOoEDW5ao3Iu02G6GdPFPH64i/view

Tests

none

Installation

Requires downloading Node.js, found here: https://nodejs.org. Inquirer: https://nodejs.com/package/inquirer.

Then (MAC) npm install (WINDOWS) C:>npm install

Finally, run npm init from the root directory of the repository.

Contributing

If you would like to contribute, information coming soon.

Questions

Have questions? You can find me on GitHub: https://github.com/BeKind-Rewind

Or email me at: challenge641@gmail.com

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published