Giter Club home page Giter Club logo

good-readme-generator's Introduction

Good-README-Generator NPM

Project Gif

Project gif

Table of Contents

  1. Introduction
  2. Description
  3. Installation
  4. Usage
  5. License
  6. Contributing
  7. Tests
  8. Questions

User

CMFuertes

Repository Name

Good-README-Generator

Description

This project is a tool that will generate a README.md file and format it based on answers you provide.

Repo link - https://github.com/CMFuertes/Good-README-Generator

Installation

You will need to run npm install in the command line to install the required Node Modules. Those are included in the package.json. If need be, you may clone this repository as well.

Usage

Change into the directory this project is located, then run node index.js.

License

MIT

Contributing

If you have any suggestions, this repository is open to changes. Make a pull request if you feel an improvement can be made.

Test

Manual tests with node "index.js" were frequently run in order to assure the README was generated properly.

Questions

Feel free to send me an email at [email protected] if you have any questions. Otherwise, I assure you, the generator is simple to use.

good-readme-generator's People

Contributors

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