https://github.com/mdyeates/readme-generator
Simplify the documentation process for your projects by effortlessly creating high-quality and informative README.md files
https://github.com/mdyeates/readme-generator
inquirer javascript nodejs
Last synced: 2 months ago
JSON representation
Simplify the documentation process for your projects by effortlessly creating high-quality and informative README.md files
- Host: GitHub
- URL: https://github.com/mdyeates/readme-generator
- Owner: mdyeates
- License: mit
- Created: 2023-01-21T16:55:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-11T02:19:29.000Z (about 2 years ago)
- Last Synced: 2025-02-13T23:27:39.096Z (4 months ago)
- Topics: inquirer, javascript, nodejs
- Language: JavaScript
- Homepage:
- Size: 23.7 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Professional README Generator
Simplify the documentation process for your projects by effortlessly creating high-quality and informative README.md files
Professional README Generator is proudly built by: Michael Yeates
Explore the docs »
View Walkthrough Video
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
### Screenshot
[![Professional README Generator Screen Shot][product-screenshot]](https://drive.google.com/file/d/1An-iMejFYy7drNO4IRWt8gJLWnfxd_21/view)
### Built With
- 
- 
### Description
It has never been easier to document your repository projects than with this command-line application built using Node.js. Simply provide information about your project and let it do the rest. The generated README file includes sections for the project title, description, a table of contents, installation, usage, license, contributing, tests and questions. Additionally, the user can also select a license from a list of options, which will add a badge near the top of the README file and include a reference in the license section. The user's GitHub username and email address are also added to the questions section. For easy navigation, the table of contents includes links that take users to the relevant sections.
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
- npm
```sh
npm install npm@latest -g
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/mdyeates/readme-generator.git
```
2. Install NPM packages
```sh
npm install
```
## Usage
### Functionality
- The following animation demonstrates the applications functionality. Click the gif to view the shared video on Google Drive.
[![Functionality Gif][functionality-gif]](https://drive.google.com/file/d/1An-iMejFYy7drNO4IRWt8gJLWnfxd_21/view)
## License
Distributed under the MIT License. See `LICENSE.md` for more information.
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## Tests
N/A
## Questions
If you have any inquiries, don't hesitate to reach out to me via socials or by sending an email to [email protected]
Project Link: [https://github.com/mdyeates/readme-generator](https://github.com/mdyeates/readme-generator)
## Acknowledgments
- [https://www.npmjs.com/package/inquirer](https://www.npmjs.com/package/inquirer)
[contributors-shield]: https://img.shields.io/github/contributors/mdyeates/readme-generator.svg?style=for-the-badge
[contributors-url]: https://github.com/mdyeates/readme-generator/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/mdyeates/readme-generator.svg?style=for-the-badge
[forks-url]: https://github.com/mdyeates/readme-generator/network/members
[stars-shield]: https://img.shields.io/github/stars/mdyeates/readme-generator.svg?style=for-the-badge
[stars-url]: https://github.com/mdyeates/readme-generator/stargazers
[issues-shield]: https://img.shields.io/github/issues/mdyeates/readme-generator.svg?style=for-the-badge
[issues-url]: https://github.com/mdyeates/readme-generator/issues
[license-shield]: https://img.shields.io/github/license/mdyeates/readme-generator.svg?style=for-the-badge
[license-url]: https://github.com/mdyeates/readme-generator/blob/main/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/mdyeates
[product-screenshot]: assets/screenshot.png
[functionality-gif]: assets/readme-gen.gif
[responsive-screenshot]: https://placehold.co/600x400?text=Placeholder