Giter Club home page Giter Club logo

meerkar / readme-generator Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 2.15 MB

When creating an open source project on GitHub, it’s important to have a high-quality README for the app. The Readme should include what the app is for, how to use the app, how to install it, how to report issues, and how to make contributions—this last part increases the likelihood that other developers will contribute to the success of the projec

License: MIT License

JavaScript 100.00%
inquirer-prompt inquirerjs nodejs

readme-generator's Introduction

README Generator

This project is divided into three parts

  1. Intoduction
  2. Problem
  3. Solution

Introduction

When creating an open source project on GitHub, it’s important to have a high-quality README for the app. The Readme should include what the app is for, how to use the app, how to install it, how to report issues, and how to make contributions—this last part increases the likelihood that other developers will contribute to the success of the project. To create a README file by using a command-line application to generate one. This allows the project creator to devote more time to working on the project.

The Readme is created as a command-line application that dynamically generates a professional README.md file from a user's input using the Inquirer package.

The application will be invoked by using the following command:

node index.js

Untitled_.Feb.26.2024.2_28.PM.3.webm

Problem

To run inquirer and interact with its prompts took a bit longer than i expected . Then came with the gitignore which accidently created on the wrong path, and finally with the Screencastify where i am introduced for the first time

Solution

With the help of the my class videos and npm docs iwas able to solve the issues i came across. And was able successfully generate a readme file. And was able to meet all accepetance criteria. such as GIVEN a command-line application that accepts user input WHEN I am prompted for information about my application repository THEN a high-quality, professional README.md is generated with the title of my project and sections entitled Description, Table of Contents, Installation, Usage, License, Tests, and Questions WHEN I enter my project title THEN this is displayed as the title of the README WHEN I enter a description, installation instructions, usage information, contribution guidelines, and test instructions THEN this information is added to the sections of the README entitled Description, Installation, Usage, and Tests WHEN I choose a license for my application from a list of options THEN a badge for that license is added near the top of the README and a notice is added to the section of the README entitled License that explains which license the application is covered under WHEN I enter my GitHub username THEN this is added to the section of the README entitled Questions, with a link to my GitHub profile WHEN I enter my email address THEN this is added to the section of the README entitled Questions, with instructions on how to reach me with additional questions WHEN I click on the links in the Table of Contents THEN I am taken to the corresponding section of the README

Credits: John Young (Instructor) and Nick Gambino (TA)

readme-generator's People

Contributors

meerkar avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.