eigenvalue000 / readme-generator

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Readme Generator

AGPL-3.0-or-later

Author

Garrett Kegel

Description

The Readme Generator uses node.js with the file system and inquirer packages to create a prompt in the command line interface that accepts inputs for the project title, the author, the copyright year, the description of the project, a table of contents for a large project, the installation instructions, the usage of the application, the license selected among multiple possible license choices, a section for contributions to the project, a section for the tests used on the application, and a contact section for if someone wants to ask the author questions about the project. This is then written to a markdown file.

Table of Contents

Author

Description

Table of Contents

Installation

Usage

License

Contributing

Tests

Questions

Installation

No installation required. Clone the repository and use the command 'node index.js' to start the prompt in the CLI.

Usage

The application will ask a sequence of questions. Enter in the appropriate information for each section and the README.md file will be generated.

Alternate Text(https://youtu.be/5OUTChXx3m0) "readme-generator-video.mp4"

License

Readme Generator Copyright (C) 2021 Garrett Kegel

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

https://www.gnu.org/licenses/agpl-3.0.md

Contributing

Just Garrett Kegel so far.

Tests

No tests.

Questions

Contact the developer and owner of this repository by using the information below :

GitHub https://github.com/eigenvalue000

Email qwxzjkv20946137@gmail.com

About


Languages

Language:JavaScript 100.0%