/readme-generator

This is a readME file generator for this repository. There is no link to this site because the readME markdown file IS the project.

Primary LanguageJavaScriptMIT LicenseMIT

GitHub issues   GitHub stars   GitHub last commit

readME Generator

Description

A command-line tool that creates a readME.md file for this repository.

Table of Contents

  1. Title
  2. Description
  3. Installation
  4. Usage
  5. License
  6. Contributing
  7. Tests
  8. Questions?

Installation

  1. Be sure you've installed npm (node project manager) and node.js on your system.
  2. On your terminal command line, enter 'npm i inquirer'. This will ensure the correct node_module is installed.
  3. To run the generator, enter 'node index.js' ... then just start answering the questions!

Usage

Simply answer each question as they appear and press 'Enter' to proceed to the next question.

Usage Screenshot

License

License: MIT

This application is covered under the MIT License

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Tests

Here's a screenshot GIF of the generator being executed:

Screenshot GIF

Questions

Please direct all questions to: TheMattyD@outlook.com
Check out my GitHub Profile @ https://github.com/TheyCallMeMattyD