ncclymer / 07-Good-README-generator

This app is intended to make generating a readme easier and can be run in terminal through node.js.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Good README generator

Table of Contents

Description:

licence

The purpose of this application is to make creating a README.md file easier and provide a consistent standard of work.

Installation:

The application runs locally and will need to be copied from the git repository titled: 07-Good-README-generator. There is a link to the repository in the questions section. You will need node.js to run this file. Once you have copied 07-Good-README-generator into your code editor you will need to open the folder with the same name, and then the file named index.js in terminal. Inquirer, util, and fs are the dependencies for this application.

Usage:

 The application is run by inputting the command node index.js. This project is a form input and output design. It is run locally in terminal with node.js. After the user inputs information through terminal in response to questions that are asked, a standard README file is created.

Licence:

NOTICE! - This application has the following licence type: licence

Please visit https://opensource.org/licenses/ for more information.

Contributors:

nick clymer

Testing:

There is currently no test data available for this application.

Questions:

The repository for this application can be found at: https://github.com/ncclymer

You can also reach me directly at: nick_clymer2018@yahoo.com

Demo video and repository URL:

Git repository: https://github.com/ncclymer/07-Good-README-generator/

Demo video: https://drive.google.com/file/d/18lw8XTzlFPRvUcykqySY6WjyW16NUucT/view

Screen shot: Demo

About

This app is intended to make generating a readme easier and can be run in terminal through node.js.


Languages

Language:JavaScript 100.0%