This repository has been archived by the owner on Dec 16, 2019. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
54 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |