Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 58 lines (36 sloc) 1.185 kB
fe3d0b9 @paulirish readme updates
paulirish authored
1 # Welcome, Friend!
2
325ebaa @addyosmani Some more readme tweaks.
addyosmani authored
3 ## What am I?
4
5 Yeoman is a robust and opinionated client-side stack, comprised of tools and frameworks that can help developers quickly build beautiful web applications. We take care of providing everything needed to get started without any of the normal headaches associated with a manual setup.
6
7 Yeoman is fast, performant and is optimized to work best in modern browsers.
8
fe3d0b9 @paulirish readme updates
paulirish authored
9 ## Installing
10
450e42c @paulirish adding rvm to install dependencies. cleanup of readme. Install is eas…
paulirish authored
11 ```shell
325ebaa @addyosmani Some more readme tweaks.
addyosmani authored
12 ./setup/install.sh
450e42c @paulirish adding rvm to install dependencies. cleanup of readme. Install is eas…
paulirish authored
13 ```
14
15 Oh. That's it.
fe3d0b9 @paulirish readme updates
paulirish authored
16
17
450e42c @paulirish adding rvm to install dependencies. cleanup of readme. Install is eas…
paulirish authored
18 ## Running
fe3d0b9 @paulirish readme updates
paulirish authored
19
b9b8779 @ebidel Linux support
ebidel authored
20 Here's a small shell script that you can save as `server.sh` which opens and servers the current directory on the port specified:
21
22 ```shell
23 port=$1
24 if [ $# -ne 1 ]
25 then
26 port=8000
27 fi
28
29 if [ $(uname -s) == "Darwin" ]
30 then
31 open=open
32 else
33 open=xdg-open
34 fi
35
36 $open http://localhost:$port && python -m SimpleHTTPServer $port;
37 ```
38
39 For example, run this guy as:
40
450e42c @paulirish adding rvm to install dependencies. cleanup of readme. Install is eas…
paulirish authored
41 ```shell
b9b8779 @ebidel Linux support
ebidel authored
42 ./server.sh 8000
450e42c @paulirish adding rvm to install dependencies. cleanup of readme. Install is eas…
paulirish authored
43 ```
59c0d7f @addyosmani Adding browser support to README.
addyosmani authored
44
325ebaa @addyosmani Some more readme tweaks.
addyosmani authored
45 ## Documentation
46
47 The current documentation for Yeoman can be found [here](http://yeoman.github.com/docs).
48
49
59c0d7f @addyosmani Adding browser support to README.
addyosmani authored
50 ## Browser Support
51
52 Yeoman supports:
53
a245acd @paulirish Update master
paulirish authored
54 * Modern browsers (latest versions of Chrome, Safari, Firefox, Opera and IE10)
59c0d7f @addyosmani Adding browser support to README.
addyosmani authored
55 * Chrome on Android
56 * Mobile Safari
57
Something went wrong with that request. Please try again.