GithubHelp home page GithubHelp logo

readme-generator's Introduction

README Generator

Description

This project creates a README file based on user input in Node.js. The user is prompted with a series of questions about their project and those answers are then populated to a README file.

Table of Contents

Installation

To install necessary dependencies, run the following command:

npm install

Usage

To start the application (with Mac):

Navigate to file and type:

node index.js

Upon pressing enter, a prompt list of questions will appear and the user can answer the prompts accordingly:

gif of walkthrough in terminal

When the prompts are finished, in the repo there will be a README file that was generated with the corresponding information that the user had entered in the prompts.

sample README preview

License

This project has no license.

Contributing

[analexander] [email protected]

Tests

To run tests, run the following command:

npm run test

Questions

If you have any questions about the repo, open an issue or contact [analexander] directly at [email protected].

readme-generator's People

Contributors

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