Code Monkey home page Code Monkey logo

readme-generator's Introduction

README Generator

Description

This app makes it easier for developers to create README.md files to their projects. By using it you don't need to know the Markup language, just answer a few questions displayed on the console and the file will be generated, ready to use in your GitHub repo.

Installation

The app itself doesn't require installation, however to be able to use it Node.js needs to be installed on your computer.

How to use

  1. Clone this repository to your local machine.
  2. Execute npm install in the project folder to get the necessary dependencies.
  3. Execute node index.js to launch the README Generator.
  4. Answer the questions. Some of them are mandatory to answer, while the others if you leave them blank, "N/A" will be displayed in the generated file.
  5. You can find the generated README.md in the output folder within the project folder.

Demo video

You can watch a walkthrough video by clicking here. You will be redirected to a Google Drive folder.

readme-generator's People

Contributors

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