easyREADME-generator
Easy and Quick README file generator
Quickly generate professional README file
A deployed version can be viewed here.
Contents
About
using node.js programme answer few simple questions to make magic happen :)
User Story
CLONE or Fork Repository into your machine
OPEN Terminal and run: node index.js to start Questions
AFTER all questions been answered RENAME generated readme file to README.md
INSIDE your newly generated readme file use CMD+Click to fill in User Story an other information if required for your Project.
LASTLY Git add, commit and push your completed README.md file
Visuals:
VIDEO
https://drive.google.com/file/d/1qM8XcZlmllltE_xBW-VFW1d4PZgq6yjq/view
Installation:
Clone or Fork repository from GitHub
To clone the repo:
git clone https://github.com/Invogue01/easyREADME-generator
- In terminal type : npm i
- In terminal type: npm start
License
License used for this project - GNU AGPLv3
- For more information on license types, please reference this website for additional licensing information - https: //choosealicense.com/.
Contributing:
To contribute to this application, create a pull request. Here are the steps needed for doing that:
- Fork the repo
- Create a feature branch (git checkout -b NAME-HERE)
- Commit your new feature (git commit -m ‘Add some feature’)
- Push your branch (git push)
- Create a new Pull Request
Following a code review, your feature will be merged.
Tests:
none
Authors and Acknowledgments
Andrea
Contact Information:
*GitHub Username: invogue01
*GitHub Email: aleatrengrouse@gmail.com