Cancel changes
This software generates a quality README.md file
The software runs from the terminal using node.js. You will be guided through a series of
prompts which will be transferred to the newly generated README.md file.
This software requires the following:
- npm
- node.js
- inquirer.js
- fs.js (filesystem)
You can check if you already have node and npm installed by entering the following terminal commands:
node -v
npm -v
Some useful links:
npm
node.js
Here is a link to a video tutorial
To start the software, enter 'node index.js' from the terminal.
You will be prompted for the following items
The email address must be a valid email for example test@gmail.com.
Upon completion, if successful you will see 'Successfully created README.md!'
If not sucessful, an error will be displayed in the terminal window.
A new README.md file will be generated and will be located in the 'output' folder.
Copyright 2021 Stuart Simmons
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associateddocumentation 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 towhom 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 ofthe Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TOTHE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLEFOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUTOF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
When contributing to this repository, please first discuss the change you wish to make via email
with the owners of this repository before making a pull request
No test files yet, check again soon
Test files will be located in the 'test' folder.
Github Link: https://github.com/Pilot67/best-readme-generator
Sample README.md: https://github.com/Pilot67/best-readme-generator/blob/main/output/README.md
Video Tutorial: Screencastify video
Please direct any questions my Github profile or diret email.
My github profile, Pilot67, can be found here
If you would like to contact me directly please email me at developer@simmons1.net