The README Generator was made to create a pre-formatted README file based on prompts answered by the user in the terminal.
Description
Installation
Usage
License
Contributions
Tests
In order to install the needed node packages the command "npm install" must be entered in the terminal while the index.js file is selected. This will allow for the program to execute.
Enter usage details here. After following the installation instructions, enter "node index.js" into the terminal while the file is selected. Next, follow the prompts and answer as directed. Once finished, this will generate a README file within the current folder. The file will be pre-formatted and ready to use.
MIT
Copyright 2021 robertsunde
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.
stackoverflow.com
w3schools.com
youtube.com
npmjs.com
nodejs.org
none
Should any questions arise, please contact me at:
Github: www.github.com/robertsunde
Email: robertsundeMSU@gmail.com