/read-me-generator

Primary LanguageJavaScriptMIT LicenseMIT

Professional README Generator

Description

You can quickly and easily create a README file by using this command-line application to generate one. The app facilitates the documention and allows the user to devote more time to working on the project.

Table of Contents

Installation

The application required Node.js. Install the packages by using the following command into your integrated terminal:

npm install

Usage

The application will be invoked by using the following command:

node index.js

command line

The user will then be prompted to answer questions about their project.

questions

When the final answer is accepted, a completion message will appear.

complete

Once the questions have been fulfilled, the README file will be generated with the user's answers and saved into the 'output' directory.

file

License

License: MIT

Contributions

N/A

Tests

Tests were conducted in the command line of VS Code.