Skip to content

Latest commit

 

History

14 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

ReadMe Generator Code

License: MIT

Description

To develop a code that can allow user create automated ReadMe files using Node.JS and a npm package call inquirer.

Table of Contents

  1. Installation
  2. Usage
  3. License
  4. Credits
  5. Tests
  6. Questions
  7. Walkthrough

Installation

You need to download the Develop folder from the repository, before initializing the index.js you need to install the inquirer package using the command "npm i inquirer" once this npm package is installed. The remaining is to typ the command "node index.js" this will promp all the question to generate the ReadMe file. Once completing all the questions, the code will generate a ReadMe file with all the input information.

Usage

AS A developer
I WANT a README generator
SO THAT I can quickly create a professional README for a new project
GIVEN a command-line application that accepts user input
WHEN I am prompted for information about my application repository
THEN a high-quality, professional README.md is generated with the title of my project and sections entitled Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions
WHEN I enter my project title
THEN this is displayed as the title of the README
WHEN I enter a description, installation instructions, usage information, contribution guidelines, and test instructions
THEN this information is added to the sections of the README entitled Description, Installation, Usage, Contributing, and Tests
WHEN I choose a license for my application from a list of options
THEN a badge for that license is added near the top of the README and a notice is added to the section of the README entitled License that explains which license the application is covered under
WHEN I enter my GitHub username
THEN this is added to the section of the README entitled Questions, with a link to my GitHub profile
WHEN I enter my email address
THEN this is added to the section of the README entitled Questions, with instructions on how to reach me with additional questions
WHEN I click on the links in the Table of Contents
THEN I am taken to the corresponding section of the README

License

MIT
https://opensource.org/licenses/MIT

Credits

Abraham Soto (https://github.com/abrah-am)

Tests

N/A

Questions

Please email your questions to Kevjr1096@outlook.com. You can visit my GitHub profile at KevJr10.

Walkthrough

Visit this link to view a walkthrough of the project: https://youtu.be/We3iuIUUwNM.

This project is licensed under the MIT license.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages