readme-generator

9. README-Generator

Purpose

Using the command line interface, this application generates a professional README.md file for projects on GitHub, allowing project creators to devote more time to their projects.

This application specifically prompts for information about the application repository through a series of questions and generates a README.md with the Title, Description, Table of Contents, Installation instructions, Usage, License, Contributing, Tests and Questions sections.

In the future, this project may be improved for editability.

Built With

Installation

  1. Clone the Git repository. Navigate to the folder and run the following commands in your command line to install the npm package dependencies.
  2. “npm init”
  3. “npm install inquirer”
  4. “npm install bser”
  5. Invoke the application with “node index.js”

Usage

Answer prompts in command line to generate README.md.

Demo Video

https://youtu.be/vwrzEFHJ4tM

Repo Website

https://maxaeon.github.io/readme-generator

Questions

For additional questions and information, please go to github.com/maxaeon/ or reach out via email at maparks@ucdavis.edu.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.