Giter Club home page Giter Club logo

readme_generator's Introduction

Readme Generator

Table of Contents

Description

This project allows you to generate a detailed and quality readme file from questions asked in the terminal.

License

MIT License

Installation

First, clone the repository with git clone [email protected]:ryansheehy0/Readme_Generator.git.

Second, run cd Readme_Generator/Develop.

And finally, run npm install to install the necessary package to get Readme Generator to work.

Usage

Just run node {Path to Readme_Generator/Develop}/index.js and answer the questions when they popup. screenshot 0

Video Link

Credits

Resources

Tests

Just install the project and follow the steps for using the app.

Issues/Questions

In the github page just click on the issues tab and then click the New issue button. Please try to leave a description of your problem and what steps you took that lead to the problem.

If you have any questions or issues feel free to reach out to me at

Guthub: ryansheehy0

or

Email: [email protected]

Contributing

First, clone the repo.

Second, make a new branch with git checkout -b {branch name}.

Third, create your change in this new branch.

Forth, push your code to your newly created branch.

And finally, make a pull request on the github page.

Please make sure to leave comments on your newly created code.

readme_generator's People

Contributors

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