Skip to content

HTTPS clone URL

Subversion checkout URL

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