Giter Club home page Giter Club logo

professional-readme-generator's Introduction

Professional-README-Generator

Description

  • You can quickly and easily generate a README file by using a command-line application to generate one. This allows the project creator to devote more time working on the project.

Table of Contents

Installation

Usage

https://drive.google.com/file/d/1H5FXMI3gXlqx74iYi-LKsaZIdYxCL2wo/view

Credits

License

badge
This application is covered by the Academic license.

Features

  • Creates a readme file after collecting needed information.

Tests

  • none

Reach Out

  • @Jay1194

  • [email protected]

  • If you have any questions dont hesitate to send me an email to my inbox on github!

professional-readme-generator's People

Contributors

jay1194 avatar

Watchers

 avatar

professional-readme-generator's Issues

Prompt User Input and Output Questions

Description

  • User enters project title and Project title is then displayed as the title of the README.

  • When user enter a description, installation instructions, usage information, contribution guidelines, and test instructions
    then information is then added to the sections of the README entitled Description, Installation, Usage, Contributing, and Tests.

  • When a license is chosen for my application from a list of options
    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.

Inquirer Prompt Setup

Description

  • Prompted for information about my application repository.

  • 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.

User Prompt Links

Description

  • When user enters their GitHub username this is added to the section of the README entitled Questions, with a link to my GitHub profile.

  • When user enters their email address this is then added to the section of the README entitled Questions, with instructions on how to reach me with additional questions.

  • When user clicks on the links in the Table of Contents they are then taken to the corresponding section of the README.

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.