https://github.com/snugug/generator-sketch
Small Yeoman generator to quickly spin up a small repo for testing
https://github.com/snugug/generator-sketch
Last synced: about 1 year ago
JSON representation
Small Yeoman generator to quickly spin up a small repo for testing
- Host: GitHub
- URL: https://github.com/snugug/generator-sketch
- Owner: Snugug
- Created: 2014-02-21T01:56:35.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2014-04-08T15:02:28.000Z (about 12 years ago)
- Last Synced: 2025-04-15T09:31:01.898Z (about 1 year ago)
- Language: JavaScript
- Size: 203 KB
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sketch [](http://badge.fury.io/js/generator-sketch)
```
_______ __ __ __
| _ | |--.-----| |_.----| |--.
| |___| <| -__| _| __| |
|____ |__|__|_____|____|____|__|__|
| | | _______________________
| | / //=================/`"-._
`-------' | ||=================| D
\___\\_________________\__.-"'
```
> A [Yeoman](http://yeoman.io) generator for sketching in HTML, Sass, and JS
## Getting Started
### What is Yeoman?
Trick question. It's not a thing. It's this guy:
Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.
Not every new computer comes with a Yeoman pre-installed. He lives in the [npm](https://npmjs.org) package repository. You only have to ask for him once, then he packs up and moves into your hard drive. *Make sure you clean up, he likes new and shiny things.*
```
$ npm install -g yo
```
He also likes to bundle up his [Sassy](http://sass-lang.com/) friends. You only need to get his [packaging tape](http://bundler.io/) once, and then he'll be set. His tape lives in the [RubyGems](http://rubygems.org/) package repository.
```
$ gem install bundler
```
### Yeoman Generators
Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.
To install generator-sketch from npm, run:
```
$ npm install -g generator-sketch
```
Finally, initiate the generator:
```
$ yo sketch
```
Sketch also has some templates to make sketching easier. The following templates are available:
#### Templates
Quickly spin up templates of commonly used patterns!
```
$ yo sketch:template
```
Currently available templates:
* Style Tile - A Responsive [style tile](http://styletil.es/), including the Sass required to power the basic tile. Copy taken from [Fillerama](http://chrisvalleskey.com/fillerama/). Run Template from the root of your directory.
### Getting To Know Yeoman
Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.
If you'd like to get to know Yeoman better and meet some of his friends, [Grunt](http://gruntjs.com) and [Bower](http://bower.io), check out the complete [Getting Started Guide](https://github.com/yeoman/yeoman/wiki/Getting-Started).
## License
MIT