Coder Social home page Coder Social logo

readme-generator's Introduction

README Generator

Please note that you will have to make a copy of this and then run the actions in the command line. You can click on the link to see the video of how to use this application. https://jeffthao.github.io/readme-generator/

Description

This will help you write a nice and easy readme for your github repos.

Installation

npm i

License

Image of license

Testing

In order to test, please run npm test

Report a problem

To report any issues, you can email me at [email protected], or create an issue on this repo.

How to use

First, you would need to have node.js install. Then run it in VS code and open the terminal in there. Make sure that you are in the correct file and you have all the required dependents installed. Once you do, type in node {yourFileName.js} and a series of questions will pop up for you to answer.

Note, {yourFileName.js} is the name of your file.

How to contribute

First, you should fork a copy and clone it onto your machine. Then all commits and pushes should be going to your forked verson. After that, all submits should go a pull request so your changes can be reviewed.

GitHub

You can check out more of my work at JeffThao.

readme-generator's People

Contributors

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