Skip to content

Mathew-Harvey/ReadMe-Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ReadMe Generator

GitHub followers

License type

Table of Contents

Demo 💻

Demo Video

Discussion Video

Link to video of me discussing the code: https://youtu.be/fBGYge2WbxU

Description 🧐

Use this readme generator to easily generate functional readme's like this one! On Github, the README file is like the landing page of your website because it is the first thing visitors see. You want to make a good first impression.

Motivation 🚀

I wanted a tool to generate standardised readme.md files for my repo, so developed this node.js application.

Installation 🛠️

  1. Clone the repository, git clone https://github.com/Mathew-Harvey/ReadMe-Generator.git , 2. Change the working directory cd github-profile-ReadMe-Generator, 3. Install dependencies npm install , inquirer install , and fs install , 4. Run the app node index.js , You are all set!

Usage 🏃‍

Run the node index.js generate command, follow the prompts and a README file will be generated for you.

License 🎓

This application is licensed under: MIT

How to Contribute 🍰

Create an issue or pull-request. You are also very welcome to throw me a message at @Mathew-Harvey

Authors ✨

Mathew Harvey

Questions 🤔

Please feel free to contact me with any questions you may have:

Application ScreenShots 📸

Screen Shot

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published