ReadMePro

Description

ReadMePro is a robust command-line tool designed to help developers effortlessly generate professional README.md files for their GitHub repositories. By answering a series of intuitive prompts, users can create well-structured and informative documentation that enhances project visibility and comprehension.

Table of Contents

• Installation
• Usage
• License
• Contributing
• Tests
• Questions
• Video Demo
• Technologies Used
• FAQ
• Code Source

Installation

npm install

Usage

To use ReadMePro, navigate to your project directory in the terminal and execute the command 'node index.js'. Follow the on-screen prompts to input your project details, and a customized README.md file will be generated in your directory.

License

This project is licensed under the MIT license.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your enhancements. For major changes, please open an issue first to discuss what you would like to change.

Tests

npm test

Questions

If you have any questions about the project, feel free to reach out:

• GitHub: ReplicantCoder9000
• Email: [email protected]

Walkthrough Video

https://www.youtube.com/watch?v=c081iRKEBP8

Technologies Used

• JavaScript
• Node.js
• Inquirer.js

FAQ

Q: How do I install ReadMePro?

A: Run npm install in your project directory to install the necessary dependencies.

Q: Can I customize the generated README?

A: Yes! Simply follow the prompts and input your project-specific details.

Code Source

Code Source

All source code for this project is located in the following files:

• index.js: Main application logic and user prompts.

• generateMarkdown.js: Functions to format user input into Markdown.

• package.json: Project dependencies and scripts.