generator-cake-addin

A yeoman generator to get you quickly set up for writing Cake Addins

This generator will get you set up with a basic project structure for a new Cake Addin, as well as adding basic configuration, documentation, and a cake build script using Cake.Recipe (with bootstrappers). It will also add a appveyor build file (optionally with linux enabled) and an optional travis build file.

Table of Contents

• Install
• Usage
• Maintainer
• Contributing
  • Contributors
• License

Install

Installing through npm

npm install --global yo generator-cake-addin

Installing through yarn

yarn global add yo generator-cake-addin

Usage

The most basic use of the generator is to run the main generator by using the following command:

yo cake-addin

You may also run any of the sub generators located in the source directory (all folders except app and utils a sub-generator).

yo cake-addin:sub-generator

Maintainer

Kim J. Nordmo @AdmiringWorm

Contributing

generator-cake-addin follows the Contributor Covenant Code of Conduct.

We accept Pull Requests. Please see the contributing file for how to contribute to generator-cake-addin.

Small note: If editing the Readme, please conform to the standard-readme specification.

This project follows the all-contributors specification. Contributions of any kind welcome!

Contributors

Thanks goes to these wonderful people (emoji key):

Kim J. Nordmo 🚧 💻 📖 🤔 👀 ⚠️

allcontributors[bot] 📖

Gary Ewan Park 📹 💻 🐛

Nils Andresen 🤔

License

GNU General Public License v3.0 or later © Kim J. Nordmo