Generate a standard README markdown file for your project from the command-line.
Install the necessary dependencies:
npm i - Invoke README Generator using the following command:
node index.js - You will then be prompted for information to generate the README for your GitHub online repository via a series of questions that accept user input, including:
- GitHub username
- email address
- title of project
- project description
- license
- command to install any dependencies,
npm iby default - command to run any tests
usageinformation
- contributor guidelines
The program then generates a simple README.md file from your input with:
* The title of your project * Sections entitled: * Description * Table of Contents * Installation * Usage * License * Contributing * Tests * Questions - Finally, find the generated README in the \generated folder
https://github.com/stevelab1/simple-readme-generator/issues
This project is licensed under the MIT license.