This application was created to generate a template for a good README.md file. The application runs using node.js and generates a README file based on user input using the command line. The file is generated complete with a table of contents linked to each section. The application also gives the option of which type of license to choose for the project and allows the user to choose guidelines for contributing to the project. This README file template was created using this application.
To install this application you must be running node.js and requires these node packages: inquirer, fs, and util.
- Install node.js - instructions for installing node.js can be found here: https://nodejs.org/en/
- Open the command prompt and navigate to your working folder.
- Run npm install to install required node modules. More detailed instructions can be found here: https://www.npmjs.com/package/npm-install
- Once the modules are installed you can run the js file using node by typing
node yourFilename.js - Answer the questions when prompted.
- Your README file will be automatically generated in the same directory that where your js file is located.
Follow the command prompts to create a good README file. Check out this video for a demonstration of how the applicaton works
When using this README generator, you are provieded with the option of writing your own custom policies for contributing or you can use the the default option of the The Contributor Covenant Code of Conduct.
There were no written tests performed on this application but it has been tested many times in both node.js and using the command prompt.
If you have any questions about this project feel free to email me at jaychap77@yahoo.com.
For more information, or to check out my other projects visit my github page: jaychapman.