Description
This project is for self-improvement and practice in order to provide myself with confidence within this industry.
This is a README generator to quickly create a professional README for a project.
Installation
To install the project, I've initiated my local working folder into a GitHub Repository, then pushed the local files to the Repository after adding and commiting the updated codes using VSC.
Please download Node in order to run this app.
This application uses file system and inquirer module.
Usage
Use the inquirer to answer questions to create your README.
Demo:
Google Drive Link for Demo:
https://drive.google.com/file/d/1QPMpg7xeFGIqZzETKu-sxiU4kkN8FPAw/view
GitHub Repository:
https://github.com/arkenwald/readme-generator
Credits
Collaborated with:
Website Resources:
https://www.npmjs.com/package/inquirer/v/8.2.4
https://choosealicense.com/licenses/
https://www.sitepoint.com/understanding-module-exports-exports-node-js/
https://coding-boot-camp.github.io/full-stack/github/professional-readme-guide
License
MIT License
Copyright (c) 2023, Peter Tong
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.