slush-crumpet v0.2.3

slush-crumpet

Slush generator for creating Crumpet framework based projects.

Getting Started

Installation

Requires node (http://nodejs.org/)

If you haven't already, install gulp globally:

$ npm install -g gulp

Install slush-crumpet globally:

$ npm install -g slush-crumpet

Usage

Create a new folder for your project:

$ mkdir my-slush-crumpet

Run the generator from within the new folder:

$ cd my-slush-crumpet && slush crumpet

slush crumpet will run npm install during project generation.

Run gulp to build out project.

$ gulp

The gulp command will build html, css, js, and optimize images; as well as running a web server for local development (including livereload).

Now... honey-up that toasted crumpet!

Getting To Know Slush

Slush is a tool that uses Gulp for project scaffolding.

Slush does not contain anything "out of the box", except the ability to locate installed slush generators and to run them with liftoff.

To find out more about Slush, check out the documentation.

Contributing

See the CONTRIBUTING Guidelines

Support

If you have any problem or suggestion please open an issue here.

License

The MIT License

Copyright (c) 2014, Steve Viens

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.