Giter Club home page Giter Club logo

readme-creator's Introduction

README Creator

License: MIT

Description

This app is a simple README file generator that will generate a professional read me file for your projects. All information is handled by questions that will be asked by the console. This application was an exercise to get used to running Javascript applications through node.js, and using some node modules such as the FS (file system) and inquirer modules. This was also the first time that I have used modulation between two seperate javascript files.

Installation

Simply fork or copy the repository, cd into the repo on your machine, and then run npm install in order to install the inquirer package.

Usage

Youtube Video Tutorial

When you cd into the repo, type node index.js into the console and answer the prompts. Once you are finished, a README-Template.md file will be generated for you to copy and paste to whatever project you would like to use it for.

Any prompts that you leave blank will not be included in the readme file.

Credits

Inquirer

Starter code can be found here

License

MIT

This project is licensed under the MIT license.

readme-creator's People

Contributors

umbelth94 avatar xandromus avatar gachoi06 avatar

Stargazers

 avatar Michael Schroeder 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.