Chad Ward’s README text generator
Description
This project was created to for the user to ensure they have the minimum requirements for a README for their project. By answering a few prompts, the generator will take the data and create a README in markdown for the user to add to their project page. The generator will create a working table of contents and enter the data in the correct sections. The README will be editable in case the user needs to make changes to the document.
Table of Contents
Installation
Steps to install the application: Must have the latest version of Node.js installed. The user must also install a .gitingore file with node_modules and .DS_store included in the file for proper execution of the application. The user may also need to install node inquirer and fs on their system, or run rpm init if it does not function correctly to have the proper package.json files.
Usage
To use the application, the user will run node on the index.js file. This will take them through a series of prompts to develop their README file. Once complete, the application will generate a README that will be saved to their local machine and in the git for which this application is stored.
The demo video of this application can be viewed here.
Credits
This project was designed as a coding bootcamp challenge with starter code provide from GitHub user Gachoi06 at the following link: https://github.com/coding-boot-camp/potential-enigma.
Contributing
If you would like to contribute to this project, please contact me for permission.
Tests
If you would like to test this, it is suggested that you clone this project, and run tests on a separate branch to ensure proper functionality of the application.
License
This project is licensed under the MIT license.
Questions
If you have any questions about this project, please contact Chad Ward at chadward505@gmail.com. You can also find more of my projects on my GitHub page at https://github.com/chwd31.