Skip to content

cwarmbrunn/dynamic-readme-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Title:

README Generator


Project Description/Summary:

Creating a Node.js application that dynamically generates a site after receiving user input via the terminal.


Live Site:

As this is a site built with Node.js inputs - there is no live site. Please see the "Installation" section.


Technology Used:

  • JavaScript
  • Markdown
  • Node.js

Installation:

In order to install this application, you will need Node.js on your local computer and have this repo cloned. Once you have that installed properly, you will need to open a terminal - either through VSCode or GitBash and input the command "node index.js". This will trigger a series of user prompts that you will need to complete. The ones that are marked "Required" will require an input and cannot be skipped.


Screenshot and Video Link: Screenshot of a terminal displaying user input and a neatly generated README.md file

Check out a video of the README generator in action here

About

Creating an application that allows users to quickly and easily generate a README file by using a command-line application to generate one. This allows the user to dedicate more time to working on the project.

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors