From ccb9391b1b9a112b820ca0b6506fa2cdee4e2447 Mon Sep 17 00:00:00 2001 From: Paul Miller Date: Wed, 28 Mar 2012 18:06:41 +0300 Subject: [PATCH] Update description. --- README.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 54 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ead8eb4..f4d6c39 100644 --- a/README.md +++ b/README.md @@ -1 +1,54 @@ -# Welcome to Brunch +# Brunch with coffee +This is a simple coffee skeleton for [Brunch](http://brunch.io/). + +Main languages are [CoffeeScript](http://coffeescript.org/), +[Stylus](http://learnboost.github.com/stylus/) and +[Eco](https://github.com/sstephenson/eco). + +## Getting started + +Clone the repo and run `npm install` & `brunch build`. +See more info on the [official site](http://brunch.io) + +## Overview + + config.coffee + README.md + /app/ + /assets/ + index.html + humans.txt + images/ + collections/ + models/ + styles/ + routers/ + templates/ + views/ + initialize.coffee + /test/ + functional/ + unit/ + /vendor/ + scripts/ + backbone.js + jquery.js + console-helper.js + underscore.js + styles/ + normalize.css + helpers.css + +* `config.coffee` contains configuration of your app. You can set plugins / +languages that would be used here. +* `app/assets` contains images / static files. Contents of the directory would +be copied to `build/` without change. +Other `app/` directories could contain files that would be compiled. Languages, +that compile to JS (coffeescript, roy etc.) or js files and located in app are +automatically wrapped in module closure so they can be loaded by +`require('module/location')`. +* `test/` contains feature & unit tests. +* `vendor/` contains all third-party code. The code wouldn’t be wrapped in +modules, it would be loaded instantly instead. + +This all will generate `public/` (by default) directory when `brunch build` or `brunch watch` is executed.