Skip to content

Generate a professional README file in minutes with this new application

Notifications You must be signed in to change notification settings

LeinadZz/Readme-Genarator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Readme-Genarator

In this challenge we created a readme file genarator, when run, a series of prompts are shown in your intagrated terminal. Your answers will then be placed in a genarated readme file.

User Story

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

Installation

This application uses Inquirer, so be sure to use npm install before running.

Usage

To run the application, use node index.

You will be prompted with questions, just answer them with the best of your ability.

You will then find your newly genarated README file in the exported/ folder.

To Run Locally

Clone the project

  git clone https://github.com/LeinadZz/Readme-Genarator

Go to the project directory

  cd my-project

Install dependencies

  npm install

Run the Genarator

  node index

Demo

Watch Demo here !

README.Generator.Showcase.mp4

Screenshot

Desktop Screenshot 2022 10 08 - 10 22 35 04

About

Generate a professional README file in minutes with this new application

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published