- Description
- Motivation
- Features
- Technologies Used
- Contribution Guidelines
- Testing Instructions
- User Story
- Installation and Usage
- GitHub Repository
- Credits
- License
- Badges
- Questions
Professional README Generator is a command-line application that generates top-notch README.md files for GitHub projects. The user fills in sections such as Description, Usage, Licence, Installation, Contribution, Tests, Questions.
The goal of this project is to make the process of producing polished README files for GitHub repositories quicker and simpler. Developers can spend more time working on their projects by automating this task.
- Interface with a command line for user interaction.
- Creation of the README files with sections customised for the specifics of the project.
- Badges added for licence details automatically.
- Linking to the user's GitHub profile.
- Creation of a table of contents with links that can be clicked and redirected to the named parts of the dcoument.
Inquirer.js
JavaScript
GitHub
Markdown
Node.js
npm
Shields.io
Visual Studio Code
Please adhere to these guidelines in order to contribute to the Professional README Generator project:
Fork the repo.
Clone the fork.
Make a branch.
Make the necessary adjustments.
Check your modifications.
Ensure your modifications are committed.
Push to your fork.
Submit a pull request.
Take these actions to run the Professional README Generator tests:
Make sure you've used npm install to install all required dependencies.
Use npm test to execute any test scripts included in the project.
Make sure your contributions pass each test by looking over the test outputs for any mistakes or failed tests.
I want a README generator as a developer so that I can quickly and professionally write a README for a new project.
Make a local copy of the repository on your computer.
Open your terminal and navigate to the project directory.
To install the necessary dependencies, run npm install.
You only need to execute node index.js in your terminal and follow the instructions to use the Professional README Generator.
After you complete the questions, your project directory will have a README.md file.
A walkthrough video demo of the Professional Readme Generator
Sample of the app generated README file
Link to the GitHub repository for the Professional README Generator
The following resources were instrumental in this project’s completion:
Badge generation via Shields.io
Coding Boot Camp: Professional README Guide
GitHub's list of licenses for the project
This project is licensed under the MIT License.
Please get in touch with me using the information below if you have any questions or need more details about the Professional README Generator project:
GitHub Profile: Natt5
Email Address: Contact me
Your contributions and feedback are welcome!