Skip to content

Kurohyou/genme-SC

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues mit License

LinkedIn Patreon


Genme!

A project initializer to start off with high quality documentation and folder structure

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot A readme generator created for the UofU Full Stack Bootcamp. It kind of ran away with me.

(back to top)

Built With

  • JS
  • Node
  • Inquirer
  • {{ Mustache }}
  • Axios

(back to top)

Getting Started

Download the repository's code and use it in your directory that you want to use the generator in.

Prerequisites

Node, NPM

(back to top)

Usage

Create a readme template to fill with info about your project (like the readme you're reading right now!).

(back to top)

Roadmap

  • Custom Project Templates
  • Custom default answers
  • Ability to call the generator from another directory See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the mit License. See LICENSE.txt for more information.

(back to top)

Contact

Scott Casey - @Kurohyoustudios - [email protected]

Project Link: https://github.com/Kurohyou/genme-SC

(back to top)

Acknowledgments

UofU Full Stack Bootcamp

This readme template adapted from the Best-README-Template by Othneil Drew. Readme generated by Genme! by Scott Casey.

(back to top)

About

A CLI readme generator

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published