/readmegenerator

Primary LanguageJavaScriptMIT LicenseMIT

README Generator

License: MIT

Description

This is a nodejs terminal application to generate a simple README.md file

Table of Contents

Installation

In the terminal, navigate to the parent folder of the README Generator project files and run npm install

Usage

  1. Navigate to the parent folder of the project files and run node index.js
  2. Answer the questions as prompted
  3. The README file is saved in the same folder named [Application Title]_README.md

Video

Screenshot of video

Repo-Contents

  • js files (application)
  • package.json files (run npm install to install necessary dependencies)

License

README Generator is MIT licensed

Contributing

Feel free to contribute to this project by forking the repo, making your changes and creating a pull request when you're ready.

Questions

If you have any questions, contact me:

Email: l.teal21@gmail.com

GitHub Profile