paveldarii / README-generator

As a developer is important to be efficient, so this application can help any developer to create a structured professional readme with the descriptions in minutes.

Readme generator

Table Of Contents

1. License

2. Description

3. Installation

4. Usage

5. Questions

Description

Readme generator application consists of two folders. First folder name is js, and it contains inquirer modules plus code that is written by me can be found in the index.js. Second folder is generated-readme, so there can be found the generated README file after the application was run.

Example of folder structure is bellow:

Example of generated README file is bellow:

Installation

To install the application run the command bellow in your bash/terminal:

git clone [e-mail]:paveldarii/README-generator.git

After you downloaded the whole folder on your computer. Open terminal/bash, then enter to the js folder directory. Then, run the next command there:

npm instal inquirer

Usage

After installation of the application, run the index.js file in the terminal/bash by using command:

node index.js

Make sure that you are in js folder directory.

After you run the index.js file, you should get several questions regarding what needs to be inserted in the readme file, so after you answered all the questions, automatically will be generated a README file in the generated-readme folder.

YouTube readme generator usage demo

Questions

My GitHub profile: https://github.com/paveldarii.

My email address: [e-mail]

License

The MIT License