Add testing via grunt.

[profile/ivi/cowhide.git] / README.md

diff --git a/README.md b/README.md
index 2aa3a00..d096cdf 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +1,45 @@
 # COWHIDE
 
+Cowhide is an HTML5 UI framework built on top of Twitter Bootstrap.
+It takes advantage of Bootstrap's modularity both with regards to JavaScript
+plugins and CDD style.
+
+Bootstrap's JavaScript components are written as jQuery plugins, in a very
+minimal way, and that makes it easy to work with them.
+
+Bootstrap's strength resides in its CSS styles, created using the LESS
+language.
+
+Cowhide encapsulates Bootstrap's components and extend their functionality,
+and implements its own new UI widgets as well.
+
+
 ## Components
 
-Twitter Bootstrap 2.1.1
+jQuery, jQuery UI, Twitter Boostrap, Underscore
+
 
 ## Buiding
 
-Building requires `npm` and `make`.
+Building requires `npm`. There are only three simple steps to installing
+Cowhide:
 
     source env.sh
     npm install
+    git submodule init
+    git submodule update
+    (cd lib/jquery; npm install; grunt)
+    (cd lib/jquery-ui; npm install; grunt build)
     grunt
+
+
+## Testing
+
+To run the unit tests, you will need `phantomjs`. You can install it on Ubuntu
+with:
+
+    apt-get install phantomjs
+
+Then run:
+
+    ./tests/run.sh