Skip to content

Latest commit

 

History

19 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

License Badge

Readme-Generator

A command line based readme generator using node.js. This takes input from a user and generates an professional README.md file from the input with subheadings and a table of contents.

Installation

Clone the project or download a zip using the GitHub links above.

Install node.js if it is not already on your machine

Run npm install

Usage

Run 'node index.js' to start the generator. A series of prompts will ask you for details of your project. Fill in the details. When you have finished, your README file will be generated in the /generated folder.

License

This project is covered under the MIT license.

Demo

Readme-Generator-Demo-TH.mp4

About

A command line README generator using node.js

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages