Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 200 lines (129 sloc) 8.596 kb
bb08480 Sindre Sorhus Travis: Only show status of master branch
sindresorhus authored
1 # Welcome, Friend! [![Build Status](https://secure.travis-ci.org/yeoman/yeoman.png?branch=master)](http://travis-ci.org/yeoman/yeoman)
fe3d0b9 Paul Irish readme updates
paulirish authored
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
e6c3ecf Andy Matthews Updating readme to add Yeoman logo and assorted images.
commadelimited authored
7 ![image](http://yeoman.io/media/yeoman-masthead.png)
8
325ebaa Addy Osmani Some more readme tweaks.
addyosmani authored
9 Yeoman is fast, performant and is optimized to work best in modern browsers.
10
d063611 Sindre Sorhus Improve readme
sindresorhus authored
11 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
12
c14bcac Sindre Sorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
13
df0bc33 Addy Osmani Updating contribution section.
addyosmani authored
14 ## Installation
15
2cb710d Addy Osmani Readme tweaks: updating to reflect bower status, removing pre-release di...
addyosmani authored
16 Simply run:
df0bc33 Addy Osmani Updating contribution section.
addyosmani authored
17
18 ```shell
887ba33 Sindre Sorhus Improve the readme and remove outdated info
sindresorhus authored
19 curl -L get.yeoman.io | bash
df0bc33 Addy Osmani Updating contribution section.
addyosmani authored
20 ```
21
e147380 Sindre Sorhus Readme: Add notice about Node 0.8 requirement
sindresorhus authored
22 *Yeoman requires Node >=0.8*
23
f1f903c Addy Osmani Adding usage examples and listing of commands for contributors. This is ...
addyosmani authored
24 ## Documentation
25
edd5e79 Addy Osmani Minor tweaks, updated URL for tools used.
addyosmani authored
26 For more information on Yeoman, please read our [complete documentation](https://github.com/yeoman/yeoman/tree/master/docs/cli).
27
f1f903c Addy Osmani Adding usage examples and listing of commands for contributors. This is ...
addyosmani authored
28 Yeoman supports a powerful set of high-level commands. These include:
29
8f98e17 Paul Irish more syntax highlighting
paulirish authored
30 ```shell
f1f903c Addy Osmani Adding usage examples and listing of commands for contributors. This is ...
addyosmani authored
31 yeoman init # Initialize and scaffold a new project using generator templates
32 yeoman build # Build an optimized version of your app, ready to deploy
33 yeoman server # Launch a preview server which will begin watching for changes
47e1ce7 Bryan Bishop change 'Phantom.js' to 'PhantomJS' in docs
kanzure authored
34 yeoman test # Run a Mocha test harness in a headless PhantomJS
f1f903c Addy Osmani Adding usage examples and listing of commands for contributors. This is ...
addyosmani authored
35
b77cd39 Sindre Sorhus Cleanup readme
sindresorhus authored
36 yeoman install # Install a package from the client-side package registry
f1f903c Addy Osmani Adding usage examples and listing of commands for contributors. This is ...
addyosmani authored
37 yeoman uninstall # Uninstall the package
38 yeoman update # Update a package to the latest version
39 yeoman list # List the packages currently installed
40 yeoman search # Query the registry for matching package names
b77cd39 Sindre Sorhus Cleanup readme
sindresorhus authored
41 yeoman lookup # Look up info on a particular package
f1f903c Addy Osmani Adding usage examples and listing of commands for contributors. This is ...
addyosmani authored
42
43 ```
44
45 A common initial workflow with Yeoman might be:
46
8f98e17 Paul Irish more syntax highlighting
paulirish authored
47 ```shell
5b35606 Addy Osmani Fixes #291 - adds docs for new server profiles
addyosmani authored
48 yeoman init # Invoke the most basic application scaffold (Bootstrap, Boilerplate etc.)
887ba33 Sindre Sorhus Improve the readme and remove outdated info
sindresorhus authored
49 yeoman server # Fire off a file watch/server process which also places an
5b35606 Addy Osmani Fixes #291 - adds docs for new server profiles
addyosmani authored
50 # intermediate build of your project in `temp`
51 yeoman build # Build your project, creating an optimized version in a new `dist` directory
52 yeoman server:dist # Serve up the production-ready version of your application
53
f1f903c Addy Osmani Adding usage examples and listing of commands for contributors. This is ...
addyosmani authored
54 ```
55
56 Some more examples of how to use our commands include:
57
8f98e17 Paul Irish more syntax highlighting
paulirish authored
58 ```shell
1a7395b Addy Osmani Fixes #233 - updates references to build and intermediate dirs
addyosmani authored
59 # Generators for MVC/MV* Frameworks
a2b1c78 Addy Osmani readme tweaks.
addyosmani authored
60 yeoman init quickstart # Skip our questions and get a H5BP, jQuery and Modernizr base
61 yeoman init bbb # Backbone Boilerplate generator scaffold
62 yeoman init ember # Ember-Rails generator scaffold
887ba33 Sindre Sorhus Improve the readme and remove outdated info
sindresorhus authored
63 yeoman init ember-starter # Create a "Hello World" Yeoman project with the Ember Starter Kit
a2b1c78 Addy Osmani readme tweaks.
addyosmani authored
64 yeoman init backbone # Backbone-Rails generator scaffold
65 yeoman init angular # Invoke the AngularJS generator scaffold
66 yeoman init angular:controller # Invoke the AngularJS Controller sub-generator
1a7395b Addy Osmani Fixes #233 - updates references to build and intermediate dirs
addyosmani authored
67
68 # Generator for Chrome Apps
eeff1c4 Jonathan Beri fixed typo on "chromeapp" generator
beriberikix authored
69 yeoman init chromeapp
1a7395b Addy Osmani Fixes #233 - updates references to build and intermediate dirs
addyosmani authored
70
5b35606 Addy Osmani Fixes #291 - adds docs for new server profiles
addyosmani authored
71 # Additional server profiles
72 yeoman server:app # Serves up an intermediate build of your application
73 yeoman server:dist # Serves up a production build, if you've built before
74 yeoman server:test # Serves your test suite
75
1a7395b Addy Osmani Fixes #233 - updates references to build and intermediate dirs
addyosmani authored
76 # Package management
77 yeoman search jquery # Lookup jQuery in the Bower registry
b77cd39 Sindre Sorhus Cleanup readme
sindresorhus authored
78 yeoman install jquery underscore [depName] # Install a dependency or dependencies
79 yeoman update jquery # Update a specific dependency (e.g jquery)
f1f903c Addy Osmani Adding usage examples and listing of commands for contributors. This is ...
addyosmani authored
80 ```
e6c3ecf Andy Matthews Updating readme to add Yeoman logo and assorted images.
commadelimited authored
81 ![image](http://yeoman.io/media/yeoman-packages.png)
f1f903c Addy Osmani Adding usage examples and listing of commands for contributors. This is ...
addyosmani authored
82
edd5e79 Addy Osmani Minor tweaks, updated URL for tools used.
addyosmani authored
83 We also have [extended documentation](https://github.com/mklabs/yeoman/wiki/_pages) available for those more interested in the Yeoman internals.
f1f903c Addy Osmani Adding usage examples and listing of commands for contributors. This is ...
addyosmani authored
84
85
887ba33 Sindre Sorhus Improve the readme and remove outdated info
sindresorhus authored
86 #### Issue submission
df0bc33 Addy Osmani Updating contribution section.
addyosmani authored
87
88 In order for us to help you please check that you've completed the following steps:
89
90 * Made sure you're on the latest version
91 * Read our documentation and README to ensure the issue hasn't been noted or solved already
92 * Used the search feature to ensure that the bug hasn't been reported before
887ba33 Sindre Sorhus Improve the readme and remove outdated info
sindresorhus authored
93 * Included as much information about the bug as possible, including any output you've received, what OS and version you're on.
df0bc33 Addy Osmani Updating contribution section.
addyosmani authored
94 * Shared the output from `echo $PATH $NODE_PATH` and `brew doctor` as this can also help track down the issue.
95
887ba33 Sindre Sorhus Improve the readme and remove outdated info
sindresorhus authored
96 Then open a [new issue](https://github.com/yeoman/yeoman/issues/new) and one of the team will be happy to follow up with you.
df0bc33 Addy Osmani Updating contribution section.
addyosmani authored
97
b752b06 Addy Osmani Docs note for #249 - how to ensure you get the latest version of Bower a...
addyosmani authored
98
887ba33 Sindre Sorhus Improve the readme and remove outdated info
sindresorhus authored
99 #### Bower
2130368 Addy Osmani Adds note for #249
addyosmani authored
100
887ba33 Sindre Sorhus Improve the readme and remove outdated info
sindresorhus authored
101 Yeoman uses [Bower](http://twitter.github.com/bower/) as its package manager. The Bower registry is currently being populated, you may find that certain packages work and others do not. We are actively working with the Bower team to resolve this issue and hope to have fully functional packages in place upon launch.
eb655aa Addy Osmani Adding note about bower access.
addyosmani authored
102
325ebaa Addy Osmani Some more readme tweaks.
addyosmani authored
103
59c0d7f Addy Osmani Adding browser support to README.
addyosmani authored
104 ## Browser Support
105
d063611 Sindre Sorhus Improve readme
sindresorhus authored
106 * Modern browsers (latest version of Chrome, Safari, Firefox, Opera and IE10)
59c0d7f Addy Osmani Adding browser support to README.
addyosmani authored
107 * Chrome on Android
108 * Mobile Safari
109
e6c3ecf Andy Matthews Updating readme to add Yeoman logo and assorted images.
commadelimited authored
110 ![image](http://yeoman.io/media/yeoman-browsers.png)
c14bcac Sindre Sorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
111
8911835 Addy Osmani Fixes #127 - improves credits in readme
addyosmani authored
112 ## Platform Support
113
2cb710d Addy Osmani Readme tweaks: updating to reflect bower status, removing pre-release di...
addyosmani authored
114 Yeoman 1.0 will support OS X and Linux. We will be aiming to bring in support for Windows in a [future](https://github.com/yeoman/yeoman/issues/216) version of the project.
8911835 Addy Osmani Fixes #127 - improves credits in readme
addyosmani authored
115
c14bcac Sindre Sorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
116 ## Contribute
117
6b91fef Addy Osmani Adding tweaks to contribution guide, disclaimer for private beta testers
addyosmani authored
118 We are more than happy to accept external contributions to the project in the form of feedback, bug reports and even better - pull requests :) At this time we are primarily focusing on improving the user-experience and stability of Yeoman for our first release. Please keep this in mind if submitting feature requests, which we're happy to consider for future versions.
119
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
120 ### Repos
121
887ba33 Sindre Sorhus Improve the readme and remove outdated info
sindresorhus authored
122 Yeoman has three primary repos:
df0bc33 Addy Osmani Updating contribution section.
addyosmani authored
123
124 * [main project](http://github.com/yeoman/yeoman)
125 * [generators](http://github.com/yeoman/generators)
126 * [yeoman.io](http://github.com/yeoman/yeoman.io)
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
127
887ba33 Sindre Sorhus Improve the readme and remove outdated info
sindresorhus authored
128 ### Quick Start
129
130 * Clone this repo and `cd` into it
131 * Run this command: `./setup/install.sh`
132 * `cd` into the `/cli` directory and run `sudo npm link` after the install is complete.
133 * Navigate to a new directory and run `yeoman init` to make sure everything is working as expected.
134
135 You can keep Yeoman up to date by using `git pull --rebase upstream master && cd cli && npm link`, where `upstream` is a remote pointing to this repo.
136
c14bcac Sindre Sorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
137 ### Style Guide
138
1f00239 Sindre Sorhus Readme: Update style guide
sindresorhus authored
139 This project uses single-quotes, two space indentation, multiple var statements and whitespace around arguments. 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.
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
140
b9fe2e5 Sindre Sorhus Make the CLI code pass JSHint
sindresorhus authored
141 ### Pull Request Guidelines
142
df0bc33 Addy Osmani Updating contribution section.
addyosmani authored
143 * Please check to make sure that there aren't existing pull requests attempting to address the issue mentioned. We also recommend checking for issues related to the issue on the tracker, as a team member may be working on the issue in a branch or fork.
144 * Lint the code by running `grunt` in the `/cli` folder before submitting a pull request
145 * Develop in a topic branch, not master
b9fe2e5 Sindre Sorhus Make the CLI code pass JSHint
sindresorhus authored
146
987517f Paul Irish update readme with testing info.
paulirish authored
147 ### Tests
148
149 Yeoman has a test suite to ensure it's reliably and accurately working as a developer tool. You can find the main test suite in [`test/test-build.js`](https://github.com/yeoman/yeoman/blob/master/cli/test/test-build.js), most of the assertions are [checks against yeoman cli stdout](https://github.com/mklabs/yeoman/wiki/test-build).
150
b4b6057 Paul Irish readme update about testing
paulirish authored
151 To run our test suite:
152
153 ```sh
154 npm test
155 ```
156
b77cd39 Sindre Sorhus Cleanup readme
sindresorhus authored
157 Do note that if any CLI prompts are not accounted for the test suite will have a timeout failure.
b4b6057 Paul Irish readme update about testing
paulirish authored
158
d6c85b5 Paul Irish add to readme about our existing developer documentation.
paulirish authored
159 ### Developer Docs
160
b77cd39 Sindre Sorhus Cleanup readme
sindresorhus authored
161 We have significant developer docs for you if you'd like to hack on Yeoman.
d6c85b5 Paul Irish add to readme about our existing developer documentation.
paulirish authored
162
6b91fef Addy Osmani Adding tweaks to contribution guide, disclaimer for private beta testers
addyosmani authored
163 Currently you can find much of the details on [mklabs' yeoman wiki](https://github.com/mklabs/yeoman/wiki/_pages) but also [our primary project](https://github.com/yeoman/yeoman/tree/master/docs/cli).
d6c85b5 Paul Irish add to readme about our existing developer documentation.
paulirish authored
164
b77cd39 Sindre Sorhus Cleanup readme
sindresorhus authored
165 You're also welcome to `git blame` back to commit messages and pull requests. As a project we value comprehensive discussion for our fellow developers.
b9fe2e5 Sindre Sorhus Make the CLI code pass JSHint
sindresorhus authored
166
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
167 ## About
168
8911835 Addy Osmani Fixes #127 - improves credits in readme
addyosmani authored
169 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:
170
171 * Twitter Bootstrap
d063611 Sindre Sorhus Improve readme
sindresorhus authored
172 * HTML5 Boilerplate
8911835 Addy Osmani Fixes #127 - improves credits in readme
addyosmani authored
173 * Modernizr
174 * Twitter Bower
d063611 Sindre Sorhus Improve readme
sindresorhus authored
175 * Node.js
8911835 Addy Osmani Fixes #127 - improves credits in readme
addyosmani authored
176 * NPM
177 * Compass
d063611 Sindre Sorhus Improve readme
sindresorhus authored
178 * Socket.IO
179 * CoffeeScript
180 * Mocha
181 * Jasmine
8911835 Addy Osmani Fixes #127 - improves credits in readme
addyosmani authored
182 * PhantomJS
edd5e79 Addy Osmani Minor tweaks, updated URL for tools used.
addyosmani authored
183 * And [more...](https://github.com/yeoman/yeoman/wiki/Tools-Used)
8911835 Addy Osmani Fixes #127 - improves credits in readme
addyosmani authored
184
185 Version 1 of the project features the combined efforts of:
186
d063611 Sindre Sorhus Improve readme
sindresorhus authored
187 * [Paul Irish](http://paulirish.com)
8911835 Addy Osmani Fixes #127 - improves credits in readme
addyosmani authored
188 * [Addy Osmani](http://addyosmani.com)
d063611 Sindre Sorhus Improve readme
sindresorhus authored
189 * [Mickael Daniel](http://blog.mklog.fr)
190 * [Sindre Sorhus](http://sindresorhus.com)
8bc0352 Eric Bidelman Update master
ebidel authored
191 * [Eric Bidelman](http://ericbidelman.com)
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
192
d063611 Sindre Sorhus Improve readme
sindresorhus authored
193 and other developers.
f64ffb8 Addy Osmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
194
6b91fef Addy Osmani Adding tweaks to contribution guide, disclaimer for private beta testers
addyosmani authored
195
2cb710d Addy Osmani Readme tweaks: updating to reflect bower status, removing pre-release di...
addyosmani authored
196 ## License
197
198 Yeoman is released under a [BSD](http://opensource.org/licenses/bsd-license.php) license.
6b91fef Addy Osmani Adding tweaks to contribution guide, disclaimer for private beta testers
addyosmani authored
199
Something went wrong with that request. Please try again.