Skip to content
Newer
Older
100644 125 lines (81 sloc) 3.3 KB
fe3d0b9 @paulirish readme updates
paulirish authored Apr 12, 2012
1 # Welcome, Friend!
2
325ebaa @addyosmani Some more readme tweaks.
addyosmani authored Jun 18, 2012
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
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored Jun 26, 2012
9 For more information about the project, see [http://yeoman.io](http://yeoman.io).
10
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored Jun 26, 2012
11
fe3d0b9 @paulirish readme updates
paulirish authored Apr 13, 2012
12 ## Installing
13
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored Jun 26, 2012
14 * Clone this repo and `cd` into it
15 * Run the following command at the terminal:
16
450e42c @paulirish adding rvm to install dependencies. cleanup of readme. Install is eas…
paulirish authored May 6, 2012
17 ```shell
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored Jun 25, 2012
18 ./setup/install.sh
450e42c @paulirish adding rvm to install dependencies. cleanup of readme. Install is eas…
paulirish authored May 6, 2012
19 ```
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored Jun 26, 2012
20 * Navigate to a new directory and run `yeoman init` to make sure everything is working as expected.
450e42c @paulirish adding rvm to install dependencies. cleanup of readme. Install is eas…
paulirish authored May 6, 2012
21
fe3d0b9 @paulirish readme updates
paulirish authored Apr 13, 2012
22
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored Jun 26, 2012
23 ### Trouble-shooting
24
25 If for any reason you experience exceptions after the yeoman installation process above, you may find the
26 following steps resolve these issues:
27
28 ```
29 $ cd yeoman/cli
30 $ sudo npm install -g
31 # when complete then run..
32 $ sudo npm link
33 ```
fe3d0b9 @paulirish readme updates
paulirish authored Apr 13, 2012
34
450e42c @paulirish adding rvm to install dependencies. cleanup of readme. Install is eas…
paulirish authored May 6, 2012
35 ## Running
fe3d0b9 @paulirish readme updates
paulirish authored Apr 13, 2012
36
b9b8779 @ebidel Linux support
ebidel authored May 14, 2012
37 Here's a small shell script that you can save as `server.sh` which opens and servers the current directory on the port specified:
38
39 ```shell
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored Jun 25, 2012
40 port=$1
41 if [ $# -ne 1 ]
42 then
43 port=8000
44 fi
45
46 if [ $(uname -s) == "Darwin" ]
47 then
48 open=open
49 else
50 open=xdg-open
51 fi
52
53 $open http://localhost:$port && python -m SimpleHTTPServer $port;
b9b8779 @ebidel Linux support
ebidel authored May 14, 2012
54 ```
55
56 For example, run this guy as:
57
450e42c @paulirish adding rvm to install dependencies. cleanup of readme. Install is eas…
paulirish authored May 6, 2012
58 ```shell
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored Jun 25, 2012
59 ./server.sh 8000
450e42c @paulirish adding rvm to install dependencies. cleanup of readme. Install is eas…
paulirish authored May 6, 2012
60 ```
59c0d7f @addyosmani Adding browser support to README.
addyosmani authored Jun 4, 2012
61
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored Jun 25, 2012
62
325ebaa @addyosmani Some more readme tweaks.
addyosmani authored Jun 18, 2012
63 ## Documentation
64
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored Jun 26, 2012
65 The current documentation for Yeoman can be found [here](http://yeoman.github.com/docs). If you are a new contributor and require access to this repository, feel free to ask.
325ebaa @addyosmani Some more readme tweaks.
addyosmani authored Jun 18, 2012
66
67
59c0d7f @addyosmani Adding browser support to README.
addyosmani authored Jun 4, 2012
68 ## Browser Support
69
70 Yeoman supports:
71
a245acd @paulirish Update master
paulirish authored Jun 5, 2012
72 * Modern browsers (latest versions of Chrome, Safari, Firefox, Opera and IE10)
59c0d7f @addyosmani Adding browser support to README.
addyosmani authored Jun 4, 2012
73 * Chrome on Android
74 * Mobile Safari
75
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored Jun 25, 2012
76
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored Jul 10, 2012
77 ## Platform Support
78
79 Yeoman 1.0 will support Mac OSX and will attempt to support Linux as well. We will be aiming to bring in support for Windows in a future version of the project.
80
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored Jun 25, 2012
81 ## Contribute
82
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored Jun 26, 2012
83 ### Repos
84
85 * [Yeoman (CLI, Insights)](http://github.com/yeoman/yeoman)
86 * [Yeoman I/O Holding Page](http://github.com/yeoman/yeoman.io)
87 * [Yeoman I/O Site](http://github.com/yeoman/yeoman.io)(site branch)
88 * [Yeoman Docs](http://github.com/yeoman/docs)
89
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored Jun 25, 2012
90 ### Style Guide
91
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored Jun 26, 2012
92 This project follows the [jQuery Style Guide](http://docs.jquery.com/JQuery_Core_Style_Guidelines) with an exception of two space indentation and multiple var statements. Please ensure any pull requests follow this closely. If you notice existing code which doesn't follow these practices, feel free to shout and we will address this.
93
94 ## About
95
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored Jul 10, 2012
96 Yeoman is an open-source project by [Google](http://google.com) which builds on top of [Grunt](https://github.com/cowboy/grunt) and [node-build-script](http://github.com/h5bp/node-build-script). We utilize a number of useful open-source solutions including:
97
98 * Twitter Bootstrap
99 * Html5 Boilerplate
100 * Modernizr
101 * Twitter Bower
102 * Node
103 * NPM
104 * Compass
105 * socket.io
106 * coffeescript
107 * mocha
108 * jasmine
109 * PhantomJS
110
111 and [more](https://github.com/yeoman/yeoman/wiki/Dependencies)
112
113 Version 1 of the project features the combined efforts of:
114
115 * [Paul Irish](http://paulirish.com)]
116 * [Addy Osmani](http://addyosmani.com)
117 * [Mickael Daniel](http://blog.mklog.fr/)
118 * [Sindre Sorhus](http://http://sindresorhus.com/)
8bc0352 @ebidel Update master
ebidel authored Jun 30, 2012
119 * [Eric Bidelman](http://ericbidelman.com)
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored Jun 26, 2012
120
121 and other developers.
122
123 We will be aiming to officially release the project in late July, 2012.
124
Something went wrong with that request. Please try again.