This is a command-line application that generates a high-quality, professional README.md file based on user input. It prompts the user for information about their application repository, including the project title, description, installation instructions, usage information, contribution guidelines, and test instructions. The generated README.md file includes sections entitled Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions.
To use this application, first clone or download the repository from GitHub. Then, in your terminal, navigate to the root directory of the project and run the following command to install the necessary dependencies:
To run the application, use the following command in your terminal:
Then, follow the prompts to input information about your project. Once all prompts are complete, the application will generate a README.md file in the root directory of the project.
This project is licensed under the MIT license.
Contributions to this project are welcome! To contribute, please follow the Contributor Covenant code of conduct, and submit a pull request with your changes.
If you have any questions, please feel free to reach out via email at [email protected] or on GitHub.