From 7c9f7840fd9c70f8bbe3443e96726b5d4c79fd8f Mon Sep 17 00:00:00 2001 From: Joe Fleming Date: Tue, 19 Aug 2014 19:25:46 -0700 Subject: [PATCH] update readme --- README.md | 37 ++++--------------------------------- 1 file changed, 4 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index f15a522..fbe8f05 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,7 @@ -# Prototool +# getUserMedia -Stupid simple tool for making quick (mostly frontend) prototypes +I wanted to mess around with capturing audio via getUserMedia -Includes static server with live reload +# Boilerplate -# Usage - -Requires node, npm and bower. - -``` -npm install -bower install -``` - -Then just run `gulp` and open [localhost:8080](http://localhost:8080) - -## Code - -### Coffeescript - -Coffeescript is great for prototyping, so it's included. Anything in `src/coffee` will be compiled to JS and placed in `public/js` - -### Less - -CSS pre-processors are a god-send! Less is simple and you can drop normal CSS into it. Anything in `src/less` will be compiled to CSS and included in `public/css` - -### Require - -Require is nice, so it's included. `src/coffee/main.coffee` is the entry point. - -### Index - -`/public` is the main webroot here. `index.html` is loaded by default, and is a stripped down version of the H5BP template. Add more as needed. - -Normalizr and Modernizr are also both included. \ No newline at end of file +Started with [prototool](https://github.com/w33ble/prototool) \ No newline at end of file