/readme-generator

Primary LanguageJavaScriptMIT LicenseMIT

ACME Readme Generator

License

Description

Generates README.md files from user input, and somehow involves a giant magnet, a catapult, and a bird running on the roads of the American southwest.

Table of Contents

Installation

  • clone this repo to your local machine

  • cd to the root of the repo

  • install node modules with "npm i"

  • run the application with "node index"

Usage

  • cd to the root of the repo

  • run the application with "node index"

  • provide input at the prompts

  • find your generated README.md file in ./output/README.md"

Walkthrough Video

Demo video showing working TOC

Credits

Thank you to

  • Ben B Wright for his help with simplifying the promise handling code.

  • Microsoft Pilot AI for sample code snippets. These snippets were not incorporated into the application. Rather, they showed me a few fine points of syntax.

Testing

  • Open a defect tracking system.
  • Bang at the app for a while.
  • Note the things that go 'clunk' or 'kaboom!'

Questions

Find this and other projects on GitHub: crestonesoftware

Got questions? Contact me: elliott.davis@crestonetech.com

License

This project is licensed under the Apache 2.0 license. For license details, click on the license badge below the title of this file.