Skip to content

# 09 Node.js Challenge: Professional README Generator

Notifications You must be signed in to change notification settings

lapuzshawn/ReadME-Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 

Repository files navigation

READ ME GENERATOR ©

License: MIT

Description

The Readme Generator is a tool for developers that quickly creates a README file for their projects. This tool asks the user for information about their project, such as the title, description, and usage instructions And then it generates a professional-looking file. This tool saves developers time and effort by automating the process of creating README files. Also it makes it easier for them to share their work with others. The Readme Genarator is built using Node.js.

Table of Contents

Installation

Clone or download the Readme Generator repostory to your computer. Open a terminal or command prompt window and navigate to the root directory of the Readme Generator repository

Usage

Run the following command to start the Readme Generator: " node index.js" Follow the prompts to enter information about your project, such as the title, description, etc... Once you have entered all the necessary information, the Readme Generator will create/update the README file.

License

License: MIT

READ ME GENERATOR © is licensed under the MIT license.

For more information regarding the READ ME GENERATOR's license, please visit: https://opensource.org/licenses/MIT

Contributing

Tests

Open a terminal or command prompt window and navigate to the root directory of the Readme Generator repository. Then Run the following command to run the tests: " npm run test

Questions

If you'd like to ask questions or report issues about the READ ME GENERATOR project. Please reach out to https://github.com/Lapuzshawn. Or email us directly at example@me.com.

Releases

No releases published

Packages

No packages published