readme-generator

Readme Generator

About this project

This project is about developing a command-line application that dynamically generates a professional README.md file for open-source GitHub projects. Utilizing the Inquirer package, the application will simplify the process of creating a detailed README that includes information on the app’s purpose, usage, installation, issue reporting, and contribution guidelines. The aim is to enhance the quality of open-source projects and encourage community contributions, while allowing project creators to focus more on development work.

Built With

• 
• 

Roadmap

• Develop Command-Line Application

  • Accept user input.

• Implement README Generation with User Input

  • Include sections for:
    • Project Title
    • Description
    • Table of Contents
    • Installation
    • Usage
    • License
    • Contributing
    • Tests
    • Questions

• Dynamic Content Integration

  • Display user-entered project title as README title.
  • Insert user-provided content into respective README sections.

• License Section and Badge

  • Add chosen license badge to README.
  • Include a notice in the License section.

• GitHub and Email Information

  • Add GitHub username with a profile link to the Questions section.
  • Include email address with contact instructions in the Questions section.

• Functional Table of Contents

  • Ensure links navigate to corresponding sections in README.

• Prepare Getting Started Guidelines

  • Create a .gitignore file.
  • Ensure the repository includes a package.json file.

• Fulfill Project Submission Requirements

  • Deliverables:
    • Submit a sample README.
    • Provide the GitHub repository with application code.
  • Walkthrough Video:
    • Create and submit a demonstration video.
    • Include a link to the video in your README file.

Important note

N/A

Preview / Demo video

Also the downloadable video is available on Google Drive Or you can watch on youtube below.

This is the Github page

readme-generator

Credits

This is a practice for the bootcamp. The starter file is protected by the bootcamp.

Third-party service

• inquirer - npm

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Tak Kawamura - tkawamura11@gmail.com Takuya at X Takuya Kawamura Linkedin

This site is open source. Improve this page.