README Generator

Description

A command-line application that allows you to quickly create a professional README.md for a new project.

• README Generator
  • Description
  • Installation
    • Steps
  • Usage
    • Steps
  • Technologies/Languages
  • Demo Video
  • Images
  • License
  • Contributing
  • Questions

Installation

To install/use README Generator and it's dependecies, you will first need to have Node.JS installed on your machine.

Once you have Node.js installed continue with the following steps:

Steps

• Step 1
  • Clone/Fork Repo on to local machine.
• Step 2
  • Open terminal from root of README-generator Repo and install dependencies with the following commands:

  npm install

Usage

For best experience, use external terminal from IDE

Steps

• Step 1
  • Open terminal from root of README-generator Repo.
• Step 2
  • run the command:

  node index.js

• Step 3
  • Answer pompts - Some will open default text editor.
  • When inputting from text editor, SAVE file and close to continue.
  • If you do not save, your input will NOT be registered and will be prompted to provide input again.
• Step 4
  • When all prompts are answered a README.md will be generated and saved to the ./generated-readme folder.

Technologies/Languages

• JavaScript
• Node.js
• NPM
• Inquirer

Demo Video

Wacth full res video here

README-generator-demoVideo.mov

Images

License

This application is covered under the GNU GPL v3 License.

Contributing

For contributions you may contact me here.

Questions

Visit my GitHub profile.