GithubHelp home page GithubHelp logo

readme_generator's Introduction

README generator

License: CC0

Usage screenshot

Description

Generates a README template based off of user input. Uses the npm "inquirer" package to solicit input and then formats that content into a README to avoid having to do the basics of README generation repeatedly for each project.

A sample README generated with this tool is present in the "output" folder (also where new README files will be generated, overwriting any existing files).

Table of Contents

Installation

Run "npm i" in the directory of the repo after cloning it. Ensure that node.js is installed prior to use. Verified on node v16.17.0 (LTS).

Usage

Run "node index" in the directory of the cloned repo. Answer prompts in the terminal as they are supplied. Generated README.md is located in the "output" folder.

Video demonstration: https://www.youtube.com/watch?v=ce5kzYQ5tO8

Contributing

Not accepting contributions at this time. Feel free to fork and modify in accordance with the license.

Questions

Github: Gordon-Magill
Email: [email protected]

License

Licensed under CC0.

readme_generator's People

Contributors

gordon-magill 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.