/readme-generator

Generate a readme from prompt questions

Primary LanguageJavaScriptMIT LicenseMIT

Readme generator

Generate a readme from prompt questions

Description

  • This README generator application is created to help generate a readme file.
  • Once the application running, it will prompt you with a series of questions.
  • By given typing in the answers when the terminal gives your a question prompt it will take the input and later insert it into the necessary section in the README file.

GitHub page

Readme Generator

Installation

Node.js

  • Visit the Node website and install it.
  • Once installed, right click on the JavaScript file named index.js and select "Open in integrated terminal".
  • Type in Node index.js.
  • It will start asking you a series of questions, please answer them to the fullest.
  • After you have completed the questions it will generate a readme file in the utils folder.

Usage

Video Link

Video Link

Credits

N/A

License

MIT License

Copyright & All rights Reserved (c) 2023 Kwok Law

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.


Badges

License: MIT

Features

Generating README file.

Contributing

Tests

N/A


Copyright © 2023 K.Law All Rights Reserved.