/READMEGenerator

A README Generator that will ask the user some questions, then turn the answers into a README file for use on GitHub

Primary LanguageJavaScriptMIT LicenseMIT

READMEGenerator

License: MIT

Table of Contents

  1. Description
  2. Installation Instructions
  3. Usage
  4. Test Instructions
  5. Contribution Guidelines
  6. License
  7. Questions

Description

A README Generator that will ask the user some questions, then turn the answers into a README file for use on GitHub

This app was created to allow for the quick generation of a GitHub compliant README file written in Markdown. Using Node.js and the Inquirer package, it takes in a number of details using prompts, and puts them together into a single README.md file.

Installation Instructions

  1. Clone the project from the main branch of the repository to the local filesystem
  2. make sure that node.js and npm are installed
  3. run the command "npm install" to install the dependencies from the package.json file

Usage

  1. Using Gitbash, navigate to the folder where the project has been cloned
  2. run the following command "node index.js"
  3. answer the questions when prompted, following the instructions of the prompts
  4. for the questions that require multi-line input, the prompt will ask that you press the "Enter" key
  5. this will open your default text editor
  6. enter the information to answer the question, either typing it or pasting it from another editor, then save and close the editor
  7. once all questions have been answered, a README.md file will be placed in the results folder
  8. upload the README.md file to the repository for which you created the README file

Usage Video

https://drive.google.com/file/d/134MHS5XeG0JvatJ1P1KTwfOV0NcTNRnc/view

Test Instructions

  1. Open Gitbash, and navigate to the folder where the project has been cloned
  2. run the command "node index.js"
  3. Enter test text as answers to the prompts
  4. Observe if the README.md file has been created in the results folder
  5. Open the README.md file and confirm that the file contains the test text

Contribution Guidelines

  1. Clone the Main branch of the repository from GitHub
  2. Create a Branch and name it using the format: "feature_contributor"
  3. Create a pull request
  4. Send an email to the address listed in the Questions section, containing a summary of the contribution

License

MIT https://opensource.org/licenses/MIT A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.

Questions

GitHub name: KatsuMatsushita

GitHub Profile

To contact me, drop an email to: katsu.matsushita@gmail.com