Giter Site home page Giter Site logo

readmegen's Introduction

readMeGen

Deployed Link

https://ashlinhanson.github.io/readMeGen/

README Generator

This is an application where the user can put in information about their project and have a descriptive and complete README generated.

Table of Contents

Installation Instructions

Clone or fork files to your local machine.

Instructions for Use

(You will need to use node.js)

  1. Open your terminal or gitbash (where your index.js is stored, specifically)
  2. Run node index, then answer the prompts accordingly. Questions Example
  3. When completed you will either see "complete!" or an error message. Completed Message
  4. If "complete!" you will have an exampleREADME.md that will be created in your directory and will have all of the answers in README form. Example file
  5. If satisfied with the product, make it the projects README! README Markdown Version

View the project live thanks to ScreenCastify: Watch the video!

Questions

License License: MIT

Copyright (c) 2020 Ashli Hanson Licensed under the MIT license.

readmegen's People

Contributors

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