A node.js terminal based application to assist with generating a README.md for your GitHub repository
- Clone the repository to your local machine
- Navigate to the designated folder in bash
- Execute 'npm install' to install dependencies
- Inquirer npm package will be installed along with its own dependencies
- Run 'node index.js' from the terminal
- Follow prompts to enter all the required basic information
- Title
- Description
- GitHub username
- email address
- Choose a license for your project
- Input installation instructions
- Input a sub-level designation ( the level of indentation for this item )
- Input individual installation instruction
- Choose whether to add additional instructions
- Repeat above steps as desired
- Increasing the sub-level designation will allow building a heirarchy list
This application is covered under the MIT license.
- Add instructions for how other users are able to contribute to your project
- Follow the same steps as outlined in the usage to define contribution instructions
- Add instructions for how users are able to run tests on your project
- Follow the same steps as outlined in the usage to define test instructions
Please feel free to contact me regarding any further questions: