thadkingcole / readme_generator

A console application that generates GitHub community markdown files based on input from user.

README Generator

A console application that generates README, CONTRIBUTING, and CODE_OF_CONDUCT markdown files based on user input.

Table of Contents

• Installation
• Usage
• Contributing
• Tests
• Questions
• Credits
• License

Installation

First, clone this repository using your preferred method, SSH:

git clone [email protected]:thadkingcole/readme_generator.git

or HTTPS:

git clone https://github.com/thadkingcole/readme_generator.git

Once the repo is cloned, navigate into its root directory and run "npm i" to install the app.

cd readme_generator
npm i

back to Table of Contents

Usage

See demo video, or follow the following instructions.

Using your preferred console, navigate to the root directory of the repo where you want markdown files generated. Then enter "readme-gen"

readme-gen

Follow and answer the prompts as they appear.

Once all prompts have been answered, the app generates the following files:

1. CONTRIBUTINGgen.md
2. READMEgen.md
3. CODE_OF_CONDUCT.md (if user replied yes to contributor covenant prompt)

Review these files and make any desired changes. Once all changes have been made, delete the "gen" from the file names. This allows github to use the files and allows the files to link to each other.

back to Table of Contents

Contributing

Your contribution is most welcome! Please refer to the contributing guidelines when making contributions to this project.

Please note that this project is released with a Contributor Code of Conduct. By Participating in this project, you agree to abide by its terms.

back to Table of Contents

Tests

There are no pre-operational tests. Follow the installation & usage instructions to try the app for yourself!

back to Table of Contents

Questions

Please direct any and all questions to thadkingcole or via email at [email protected].

back to Table of Contents

Credits

• inquirer.js
• Executing shell commands with node.js
• A guide to creating a NodeJS command-line package

back to Table of Contents

License

MIT copyright (c) 2020 Thaddeus Cole.

back to Table of Contents