Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 119 lines (75 sloc) 3.548 kb
fe3d0b9 Paul Irish readme updates
paulirish authored
1 # Welcome, Friend!
2
325ebaa Addy Osmani 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
d063611 Sindre Sorhus Improve readme
sindresorhus authored
9 For more information about the project, see [yeoman.io](http://yeoman.io).
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
10
c14bcac Sindre Sorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
11
fe3d0b9 Paul Irish readme updates
paulirish authored
12 ## Installing
13
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
14 * Clone this repo and `cd` into it
d063611 Sindre Sorhus Improve readme
sindresorhus authored
15 * Run this command: `./setup/install.sh`
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
16 * Navigate to a new directory and run `yeoman init` to make sure everything is working as expected.
450e42c Paul Irish adding rvm to install dependencies. cleanup of readme. Install is easier...
paulirish authored
17
fe3d0b9 Paul Irish readme updates
paulirish authored
18
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
19 ### Trouble-shooting
20
21 If for any reason you experience exceptions after the yeoman installation process above, you may find the
22 following steps resolve these issues:
23
24 ```
25 $ cd yeoman/cli
112eeaa Sindre Sorhus Improve CLI readme
sindresorhus authored
26 $ sudo -s 'npm install -g && npm link'
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
27 ```
fe3d0b9 Paul Irish readme updates
paulirish authored
28
450e42c Paul Irish adding rvm to install dependencies. cleanup of readme. Install is easier...
paulirish authored
29 ## Running
fe3d0b9 Paul Irish readme updates
paulirish authored
30
d063611 Sindre Sorhus Improve readme
sindresorhus authored
31 Here's a small shell script that you can save as `server.sh` which opens and serves the current directory:
32
33 ```sh
34 #!/usr/bin/env sh
b9b8779 Eric Bidelman Linux support
ebidel authored
35
c14bcac Sindre Sorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
36 port=$1
d063611 Sindre Sorhus Improve readme
sindresorhus authored
37 if [ $# -ne 1 ]; then
c14bcac Sindre Sorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
38 port=8000
39 fi
40
d063611 Sindre Sorhus Improve readme
sindresorhus authored
41 if [ $(uname -s) == "Darwin" ]; then
c14bcac Sindre Sorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
42 open=open
43 else
44 open=xdg-open
45 fi
46
47 $open http://localhost:$port && python -m SimpleHTTPServer $port;
b9b8779 Eric Bidelman Linux support
ebidel authored
48 ```
49
d063611 Sindre Sorhus Improve readme
sindresorhus authored
50 You then need to make it executable: `$ chmod +x server.sh`
b9b8779 Eric Bidelman Linux support
ebidel authored
51
d063611 Sindre Sorhus Improve readme
sindresorhus authored
52 For example, run this guy as `$ server` (defaults to port 8000), or supply a port yourself `$ server 3000`.
59c0d7f Addy Osmani Adding browser support to README.
addyosmani authored
53
c14bcac Sindre Sorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
54
325ebaa Addy Osmani Some more readme tweaks.
addyosmani authored
55 ## Documentation
56
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
57 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 Addy Osmani Some more readme tweaks.
addyosmani authored
58
59
59c0d7f Addy Osmani Adding browser support to README.
addyosmani authored
60 ## Browser Support
61
d063611 Sindre Sorhus Improve readme
sindresorhus authored
62 * Modern browsers (latest version of Chrome, Safari, Firefox, Opera and IE10)
59c0d7f Addy Osmani Adding browser support to README.
addyosmani authored
63 * Chrome on Android
64 * Mobile Safari
65
c14bcac Sindre Sorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
66
8911835 Addy Osmani Fixes #127 - improves credits in readme
addyosmani authored
67 ## Platform Support
68
d063611 Sindre Sorhus Improve readme
sindresorhus authored
69 Yeoman 1.0 will support Mac OS X 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.
8911835 Addy Osmani Fixes #127 - improves credits in readme
addyosmani authored
70
c14bcac Sindre Sorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
71 ## Contribute
72
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
73 ### Repos
74
75 * [Yeoman (CLI, Insights)](http://github.com/yeoman/yeoman)
76 * [Yeoman I/O Holding Page](http://github.com/yeoman/yeoman.io)
d063611 Sindre Sorhus Improve readme
sindresorhus authored
77 * [Yeoman I/O Site](http://github.com/yeoman/yeoman.io) (site branch)
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
78 * [Yeoman Docs](http://github.com/yeoman/docs)
79
c14bcac Sindre Sorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
80 ### Style Guide
81
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
82 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.
83
b9fe2e5 Sindre Sorhus Make the CLI code pass JSHint
sindresorhus authored
84 ### Pull Request Guidelines
85
86 - Lint the code by running `grunt` in the `/cli` folder before submitting a pull request
87 - Develop in a topic branch, not master
88
89
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
90 ## About
91
8911835 Addy Osmani Fixes #127 - improves credits in readme
addyosmani authored
92 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:
93
94 * Twitter Bootstrap
d063611 Sindre Sorhus Improve readme
sindresorhus authored
95 * HTML5 Boilerplate
8911835 Addy Osmani Fixes #127 - improves credits in readme
addyosmani authored
96 * Modernizr
97 * Twitter Bower
d063611 Sindre Sorhus Improve readme
sindresorhus authored
98 * Node.js
8911835 Addy Osmani Fixes #127 - improves credits in readme
addyosmani authored
99 * NPM
100 * Compass
d063611 Sindre Sorhus Improve readme
sindresorhus authored
101 * Socket.IO
102 * CoffeeScript
103 * Mocha
104 * Jasmine
8911835 Addy Osmani Fixes #127 - improves credits in readme
addyosmani authored
105 * PhantomJS
d063611 Sindre Sorhus Improve readme
sindresorhus authored
106 * And [more...](https://github.com/yeoman/yeoman/wiki/Dependencies)
8911835 Addy Osmani Fixes #127 - improves credits in readme
addyosmani authored
107
108 Version 1 of the project features the combined efforts of:
109
d063611 Sindre Sorhus Improve readme
sindresorhus authored
110 * [Paul Irish](http://paulirish.com)
8911835 Addy Osmani Fixes #127 - improves credits in readme
addyosmani authored
111 * [Addy Osmani](http://addyosmani.com)
d063611 Sindre Sorhus Improve readme
sindresorhus authored
112 * [Mickael Daniel](http://blog.mklog.fr)
113 * [Sindre Sorhus](http://sindresorhus.com)
8bc0352 Eric Bidelman Update master
ebidel authored
114 * [Eric Bidelman](http://ericbidelman.com)
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
115
d063611 Sindre Sorhus Improve readme
sindresorhus authored
116 and other developers.
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
117
118 We will be aiming to officially release the project in late July, 2012.
Something went wrong with that request. Please try again.