Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 149 lines (95 sloc) 5.711 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
71591e6 @sindresorhus Grammar fix. Fixes #687
sindresorhus authored
5 Yeoman is a robust and opinionated client-side stack, comprising 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.
325ebaa @addyosmani Some more readme tweaks.
addyosmani authored
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
c89379a @sindresorhus Minor readme tweaks
sindresorhus authored
22 You can follow its guidance or simply walk through the [installation procedure](https://github.com/yeoman/yeoman/wiki/Manual-Install).
5228d51 @addyosmani Adding link to manual install instructions.
addyosmani authored
23
c89379a @sindresorhus Minor readme tweaks
sindresorhus authored
24 *Yeoman requires Node 0.8.x*
e147380 @sindresorhus Readme: Add notice about Node 0.8 requirement
sindresorhus authored
25
a4ff2ea @sindresorhus readme: Also move the issue submission guidelines
sindresorhus authored
26
27 ## Issue submission
28
2b568b4 @granteagon Absolute url for issue submission in readme
granteagon authored
29 Make sure you've read the [issue submission guidelines](https://github.com/yeoman/yeoman/blob/master/contributing.md#issue-submission) before you open a [new issue](https://github.com/yeoman/yeoman/issues/new).
a4ff2ea @sindresorhus readme: Also move the issue submission guidelines
sindresorhus authored
30
31
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This …
addyosmani authored
32 ## Documentation
33
edd5e79 @addyosmani Minor tweaks, updated URL for tools used.
addyosmani authored
34 For more information on Yeoman, please read our [complete documentation](https://github.com/yeoman/yeoman/tree/master/docs/cli).
35
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This …
addyosmani authored
36 Yeoman supports a powerful set of high-level commands. These include:
37
8f98e17 @paulirish more syntax highlighting
paulirish authored
38 ```shell
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This …
addyosmani authored
39 yeoman init # Initialize and scaffold a new project using generator templates
40 yeoman build # Build an optimized version of your app, ready to deploy
41 yeoman server # Launch a preview server which will begin watching for changes
47e1ce7 @kanzure change 'Phantom.js' to 'PhantomJS' in docs
kanzure authored
42 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
43
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
44 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
45 yeoman uninstall # Uninstall the package
46 yeoman update # Update a package to the latest version
47 yeoman list # List the packages currently installed
48 yeoman search # Query the registry for matching package names
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
49 yeoman lookup # Look up info on a particular package
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This …
addyosmani authored
50
51 ```
52
53 A common initial workflow with Yeoman might be:
54
8f98e17 @paulirish more syntax highlighting
paulirish authored
55 ```shell
5b35606 @addyosmani Fixes #291 - adds docs for new server profiles
addyosmani authored
56 yeoman init # Invoke the most basic application scaffold (Bootstrap, Boilerplate etc.)
887ba33 @sindresorhus Improve the readme and remove outdated info
sindresorhus authored
57 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
58 # intermediate build of your project in `temp`
59 yeoman build # Build your project, creating an optimized version in a new `dist` directory
60 yeoman server:dist # Serve up the production-ready version of your application
61
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This …
addyosmani authored
62 ```
63
64 Some more examples of how to use our commands include:
65
8f98e17 @paulirish more syntax highlighting
paulirish authored
66 ```shell
1a7395b @addyosmani Fixes #233 - updates references to build and intermediate dirs
addyosmani authored
67 # Generators for MVC/MV* Frameworks
a2b1c78 @addyosmani readme tweaks.
addyosmani authored
68 yeoman init quickstart # Skip our questions and get a H5BP, jQuery and Modernizr base
69 yeoman init bbb # Backbone Boilerplate generator scaffold
70 yeoman init ember # Ember-Rails generator scaffold
887ba33 @sindresorhus Improve the readme and remove outdated info
sindresorhus authored
71 yeoman init ember-starter # Create a "Hello World" Yeoman project with the Ember Starter Kit
a2b1c78 @addyosmani readme tweaks.
addyosmani authored
72 yeoman init backbone # Backbone-Rails generator scaffold
73 yeoman init angular # Invoke the AngularJS generator scaffold
74 yeoman init angular:controller # Invoke the AngularJS Controller sub-generator
1a7395b @addyosmani Fixes #233 - updates references to build and intermediate dirs
addyosmani authored
75
76 # Generator for Chrome Apps
eeff1c4 @beriberikix fixed typo on "chromeapp" generator
beriberikix authored
77 yeoman init chromeapp
1a7395b @addyosmani Fixes #233 - updates references to build and intermediate dirs
addyosmani authored
78
5b35606 @addyosmani Fixes #291 - adds docs for new server profiles
addyosmani authored
79 # Additional server profiles
80 yeoman server:app # Serves up an intermediate build of your application
81 yeoman server:dist # Serves up a production build, if you've built before
82 yeoman server:test # Serves your test suite
83
1a7395b @addyosmani Fixes #233 - updates references to build and intermediate dirs
addyosmani authored
84 # Package management
85 yeoman search jquery # Lookup jQuery in the Bower registry
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
86 yeoman install jquery underscore [depName] # Install a dependency or dependencies
87 yeoman update jquery # Update a specific dependency (e.g jquery)
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This …
addyosmani authored
88 ```
c89379a @sindresorhus Minor readme tweaks
sindresorhus authored
89
e6c3ecf @commadelimited Updating readme to add Yeoman logo and assorted images.
commadelimited authored
90 ![image](http://yeoman.io/media/yeoman-packages.png)
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This …
addyosmani authored
91
edd5e79 @addyosmani Minor tweaks, updated URL for tools used.
addyosmani authored
92 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
93
94
887ba33 @sindresorhus Improve the readme and remove outdated info
sindresorhus authored
95 #### Bower
2130368 @addyosmani Adds note for #249
addyosmani authored
96
887ba33 @sindresorhus Improve the readme and remove outdated info
sindresorhus authored
97 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
98
325ebaa @addyosmani Some more readme tweaks.
addyosmani authored
99
59c0d7f @addyosmani Adding browser support to README.
addyosmani authored
100 ## Browser Support
101
d063611 @sindresorhus Improve readme
sindresorhus authored
102 * Modern browsers (latest version of Chrome, Safari, Firefox, Opera and IE10)
59c0d7f @addyosmani Adding browser support to README.
addyosmani authored
103 * Chrome on Android
104 * Mobile Safari
105
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
106
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
107 ## Platform Support
108
2cb710d @addyosmani Readme tweaks: updating to reflect bower status, removing pre-release…
addyosmani authored
109 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
110
c89379a @sindresorhus Minor readme tweaks
sindresorhus authored
111
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
112 ## Contribute
113
f3308b2 @granteagon Absolute url for contributing in readme
granteagon authored
114 See the [contributing docs](https://github.com/yeoman/yeoman/blob/master/contributing.md)
6b91fef @addyosmani Adding tweaks to contribution guide, disclaimer for private beta testers
addyosmani authored
115
b9fe2e5 @sindresorhus Make the CLI code pass JSHint
sindresorhus authored
116
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored
117 ## About
118
600783a Track grunt relocation in URLs
Mike Andrzejewski authored
119 Yeoman is an open-source project by [Google](http://google.com) which builds on top of [Grunt](https://github.com/gruntjs/grunt) and [node-build-script](http://github.com/h5bp/node-build-script). We utilize a number of useful open-source solutions including:
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
120
121 * Twitter Bootstrap
d063611 @sindresorhus Improve readme
sindresorhus authored
122 * HTML5 Boilerplate
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
123 * Modernizr
124 * Twitter Bower
d063611 @sindresorhus Improve readme
sindresorhus authored
125 * Node.js
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
126 * NPM
127 * Compass
d063611 @sindresorhus Improve readme
sindresorhus authored
128 * Socket.IO
129 * CoffeeScript
130 * Mocha
131 * Jasmine
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
132 * PhantomJS
edd5e79 @addyosmani Minor tweaks, updated URL for tools used.
addyosmani authored
133 * And [more...](https://github.com/yeoman/yeoman/wiki/Tools-Used)
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
134
135 Version 1 of the project features the combined efforts of:
136
d063611 @sindresorhus Improve readme
sindresorhus authored
137 * [Paul Irish](http://paulirish.com)
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
138 * [Addy Osmani](http://addyosmani.com)
d063611 @sindresorhus Improve readme
sindresorhus authored
139 * [Mickael Daniel](http://blog.mklog.fr)
140 * [Sindre Sorhus](http://sindresorhus.com)
8bc0352 @ebidel Update master
ebidel authored
141 * [Eric Bidelman](http://ericbidelman.com)
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored
142
d063611 @sindresorhus Improve readme
sindresorhus authored
143 and other developers.
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored
144
6b91fef @addyosmani Adding tweaks to contribution guide, disclaimer for private beta testers
addyosmani authored
145
2cb710d @addyosmani Readme tweaks: updating to reflect bower status, removing pre-release…
addyosmani authored
146 ## License
147
148 Yeoman is released under a [BSD](http://opensource.org/licenses/bsd-license.php) license.
Something went wrong with that request. Please try again.