Code Monkey home page Code Monkey logo

readme-generator's Introduction

Readme Generator

Licensing:

license

Table of Contents

Presentation

Screen.Recording.2022-04-27.at.8.21.32.PM.mp4

Description:

The above gif is a demonstration of how this application is supposed to work.

  • WHEN I am prompted for information about my application repositor
    • 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, Contributing, 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, Contributing, 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

Installation:

  • Download through Github
  • Requires inquirer to be installed

Usage:

  • Open in the terminal
  • Type 'node index.js'
  • Answer the prompts that follow
  • On success a README.md will be generated in the dist folder.

readme-generator's People

Contributors

amir-hackett 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.