by Casey Layne Hyne
The building of this project is based around the use of node.js with an added inquirer (npm 8.2.4). Under the loading of "node /index.js" in your pc's intergrated terminal the user will be able to fill out a questionnaire which will upon completion generate a README.md file with all the neccessary headings, content and corresponding licenses. ( Have attatched screenshots of code above ).
- Using this project is very straight forward and first time user friendly, ensure you have your Node.js installed along with the "inquirer i @8.2.4" before running the program in your intergrated terminal.
- Open your intergrated terminal and perform your "node /index.js" this will run your index.js file and begin the README.md generator questionnaire.
- Upon completing the questionnaire the "generateMarkdown.js" code will execute and your responses will be forwarded and formatted into a newly generated README.md file in the corresponding "create" folder which can be reviewed for any errors and/or additions before pushing up to your remote GitHub repository.
- Both the "index.js" and "generateMarkdown.js" follow the exact same semantic coding structure for easy user interactability. A comprehensible coding structure also allows other developers an easier understanding of how the code interacts with one another which can be used for future use and/or revision.
- (Video walkthrough to expand on usage and coding structure attatched upon submission)
- inquirer i @8.2.4
- Name - Casey Layne Hyne
- Email - Chyne1000@gmail.com
- GitHub - Hyne-OS1
N/A
MIT License
Copyright (c) 2024 Hyne-OS1
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.