Skip to content

ryansheehy0/Readme_Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Readme Generator

Table of Contents

Description

This project allows you to generate a detailed and quality readme file from questions asked in the terminal.

License

MIT License

Installation

First, clone the repository with git clone git@github.com:ryansheehy0/Readme_Generator.git.

Second, run cd Readme_Generator/Develop.

And finally, run npm install to install the necessary package to get Readme Generator to work.

Usage

Just run node {Path to Readme_Generator/Develop}/index.js and answer the questions when they popup. screenshot 0

Video Link

Credits

Resources

Tests

Just install the project and follow the steps for using the app.

Issues/Questions

In the github page just click on the issues tab and then click the New issue button. Please try to leave a description of your problem and what steps you took that lead to the problem.

If you have any questions or issues feel free to reach out to me at

Guthub: ryansheehy0

or

Email: ryansheehy0@gmail.com

Contributing

First, clone the repo.

Second, make a new branch with git checkout -b {branch name}.

Third, create your change in this new branch.

Forth, push your code to your newly created branch.

And finally, make a pull request on the github page.

Please make sure to leave comments on your newly created code.

About

Module 9 nodeJS readme generator

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published