Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ReadMe-Generator

Description

The README generator is a command-line tool for creating professional README files. It streamlines the process by prompting users for project information and generating a high-quality README.md. It saves developers time and ensures consistent documentation for their projects.

Table of Contents

Installation

Make sure to install the inquirer package before running the script:

  • npm install inquirer

Usage

Begin by cloning the repository and subsequently accessing it on your local personal computer.

Upon successful access, ensure the installation of the INQUIRER package. This step is crucial for the proper functioning of the README generator.

Proceed to execute the command "node index.js" within the command line prompt.

Subsequently, a series of inquiries will be presented, soliciting input relevant to the README generation process and its specific parameters.

Lastly, upon completion, the process will yield an "readme.md" file within the project directory, finalizing the generation procedure.

License

  • This project is licensed under the MIT License. MIT License

Contributing

Contributions are welcome! Please refer to the Contributing Guidelines.

Tests

Just utilize the app.

GitHub: 99Anvar99

About

The README generator is a command-line tool for creating professional README files. It streamlines the process by prompting users for project information and generating a high-quality README.md. It saves developers time and ensures consistent documentation for their projects.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages