Code Monkey home page Code Monkey logo

auto-readme-generator's Introduction

Auto-ReadMe-Generator

[Linkedin:] (https://www.linkedin.com/in/hrishikesh-kanabar-b7127365/)

[Github:] (https://github.com/HrishikeshKanabar)

View Demo (Video Demo)

Click here to see demo

Web Application (how to use)

1.) You will asked few question regarding content you want include in "README" file

2.) Some questions are mandotory are marked as "Required"

3.) Once you answer all questions read me will generated as per response of your question

4.) You will find readme in "Develop/generatedReadme" folder.

5.) You can preview readme if you use VS code , use shift + ctrl + v

Full snap of web application

Web Application
Web Application
Genrated Readme
Genrated Readme

Requirement achieved

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, 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

Grading required achieved

Deliverables: 20%

Walkthrough Video: 27%

Technical Acceptance Criteria: 40%

Repository Quality: 13%

Downloads and running code locally

Step-1 git clone https://github.com/HrishikeshKanabar/Auto-ReadMe-Generator.git

Step-2 open folder in VS Code

Step-3 Install extension "open in browser"

Step-4 Change directory to "Develop" (Cd Develop).

Step-5 Run node index.js in terminal.

auto-readme-generator's People

Contributors

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