README.md

Team Profile Generator

Description

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

• Team Profile Generator
  • Description
  • Installation
    • Steps
  • Usage
    • Steps
  • Technologies/Languages
  • Images
  • License
  • Contributing
  • Questions

Installation

To install/use Team Profile 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

Steps

• Step 1
  • Open terminal from root of Team Profile Generator Repo.
• Step 2
  • run the command:

  node index.js

• Step 3
  • Answer pompts
• Step 4
  • When all prompts are answered a team.html file will be generated and saved to the ./output/ folder.

Technologies/Languages

• JavaScript
• Node.js
• NPM
• Inquirer
• Jest

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.