Dev-README-Generator

Description

Dev-README-Generator is a command-line application that helps developers quickly create a professional README file for their projects.

• Motivation: Developers often spend time manually formatting README files, which can be automated.
• Purpose: This tool streamlines README creation, allowing developers to focus on coding and their projects.
• Problem Solved: Automates the process of generating a high-quality README with essential sections.
• What I Learned: Working with Node.js, handling user input using Inquirer, and dynamically generating Markdown content. and learn about concept of the profassional Readme file.

Table of Contents

• Installation
• Usage
• Credits
• License
• Badges
• Features
• How to Contribute
• Tests
• Video

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/Dev-README-Generator.git

2. Navigate to the project folder:

   cd Dev-README-Generator

3. Install dependencies:

   npm install

4. Run the application:

   node index.js

Usage

• The application prompts the user for details about their project, such as title, description, installation steps, usage, contributors, license, and more.
• After completing the prompts, it generates a professional README.md file.

Example:

? What is your project title? My Awesome Project
? Provide a short description: This is an automated README generator.
? What are the installation steps? npm install, node index.js
...

Sample Output:

# My Awesome Project
## Description
This is an automated README generator.
...

Screenshots:

Credits

• Created by Luna Houshmans
• Built with Node.js and Inquirer
• Link for info GitHub Doc
• Info about how to choose your license Licenses

License

This project is licensed under the MIT License. See the LICENSE file for details.

Badges

Features

• Generates a structured README file automatically
• Supports different licenses
• Includes a table of contents for easy navigation
• Saves time for developers

How to Contribute

1. Fork the repository
2. Create a new branch: git checkout -b feature-name
3. Make changes and commit: git commit -m 'Added new feature'
4. Push changes: git push origin feature-name
5. Open a pull request

Tests

Run the application with node index.js and verify the generated README.md file.

Video

Watch the demo