Skip to content

Latest commit

 

History

6 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README Generator

License: Unlicense

Description

Having written nearly a dozen READMEs at this point, I've done enough coding to understand that the process could be automated. This project was also a great initial endeavor to learn NodeJS, I worked with concepts like packages, the Command Line Interface of Inquirer, and exports between scripts. This project was also a lot of fun, as I learned about the landscape of licensing, copyright, and open-source through researching the different licenses used in the generator.

Table of Contents

Installation

This program uses a few different applications. Git Bash, NodeJS, and the Inquirer package within NodeJS. Once those are installed, download this repository.

Usage

Walkthrough Video

This application is very straight-forward and easy to use. When in the project folder, use "node index.js" as a command in the command line to begin. After this, input text after the prompts or choose from a list using the arrow keys and the enter button. The file will be added to the folder when finished.

Be aware, using the program again will overwrite any files of the same name "README.md" in that folder, so be sure to save a copy of each README you make before starting again.

Contributions

If you wish to contribute to this project, please include this simple statement below with any non-trivial patches.

I dedicate any and all copyright interest in this software to the public domain. I make this dedication for the benefit of the public at large and to the detriment of my heirs and successors. I intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

License

The Unlicense

This software operates under The Unlicense. If you would like to learn more, please click on the link above.

Questions

Github

Email: ryansauter88@gmail.com

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages