update readme
This commit is contained in:
37
README.md
37
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.
|
||||
Started with [prototool](https://github.com/w33ble/prototool)
|
||||
Reference in New Issue
Block a user