/readme-generator

A small JS program that uses npm packages to write a readme with some questions that you'll answer from the command line

Primary LanguageJavaScriptMIT LicenseMIT

readme-generator

Description

This program will ask you some questions in the command line, and based on what you answer them with, create a readme file in markdown for your project. The files will be written to the output folder.

Instructions

Open the directory where the index.js file is from the command line, and then use the command node index.js

Installation

In the project directory open the cli, enter npm init -y (then enter), and then npm i (enter again) and it should install the dependencies needed

Reporting issues

On github, click the issues tab, new issue, title it, and leave a description of what needs to be done and why.

Contributions

On github, feel free to fork, or clone and make your changes and then submit a pull request describing what you are wanting to be added in