Skip to content

jenniwritescode/readme_generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markdown Generator

Table of contents

Description

Interactive command line application requests input from the user to generate a README file (in markdown format).

User Story

AS A developer
I WANT a README generator
SO THAT I can quickly create a professional README for a new project

Installation Instructions

Prerequisites: node.js version 8.x should be installed on your system, please follow these instructions to install if needed.

To run this program, download the source code (using git clone or by downloading the .zip file). Unzip file if needed. Open a Terminal window, navigate to the directory for readme_generator, and run the following commands in the terminal:

npm i

then

node index.js

Working Example

example demo

Example Output README File

screenshot of README doc

Links

Project Repository

License: WTFPL

About

README generator

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published