Update changelogs.
[profile/ivi/cowhide.git] / README.md
1 # COWHIDE
2
3 Cowhide is an HTML5 UI framework built on top of Twitter Bootstrap.
4 It takes advantage of Bootstrap's modularity both with regards to JavaScript
5 plugins and CDD style.
6
7 Bootstrap's JavaScript components are written as jQuery plugins, in a very
8 minimal way, and that makes it easy to work with them.
9
10 Bootstrap's strength resides in its CSS styles, created using the LESS
11 language.
12
13 Cowhide encapsulates Bootstrap's components and extend their functionality,
14 and implements its own new UI widgets as well.
15
16
17 ## Components
18
19 jQuery, jQuery UI, Twitter Boostrap, Underscore
20
21
22 ## Buiding
23
24 Building requires `npm`. There are only three simple steps to installing
25 Cowhide:
26
27     npm install -g grunt-cli
28     npm install
29     grunt submodules
30     (cd lib/jquery; npm install; grunt)
31     (cd lib/jquery-ui; npm install; grunt build)
32     grunt
33
34
35 ## Testing
36
37 Just run:
38
39     grunt test