Skip to content
Newer
Older
100644 179 lines (114 sloc) 7.49 KB
fe3d0b9 @paulirish readme updates
paulirish authored
1 # Welcome, Friend!
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
7 Yeoman is fast, performant and is optimized to work best in modern browsers.
8
d063611 @sindresorhus Improve readme
sindresorhus authored
9 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
10
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
11
f565bca @addyosmani Updating references to docs, tweaking.
addyosmani authored
12 ## Installing (pre-launch)
fe3d0b9 @paulirish readme updates
paulirish authored
13
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored
14 * Clone this repo and `cd` into it
d063611 @sindresorhus Improve readme
sindresorhus authored
15 * Run this command: `./setup/install.sh`
6efe9c8 @sindresorhus Update install instructions
sindresorhus authored
16 * `cd` into the `/cli` directory and run `sudo npm link`
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored
17 * 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
18
05e6312 @mattbanks make sure people run npm link after a git pull when updating
mattbanks authored
19 You can keep Yeoman up to date by using `git pull --rebase upstream master && cd cli && npm link`.
6efe9c8 @sindresorhus Update install instructions
sindresorhus authored
20
21 **Make sure to pull in the latest and test before filing an issue, it might be fixed already**
a2b1c78 @addyosmani readme tweaks.
addyosmani authored
22 **Please also be sure to double-check an issue hasn't already been reported before submitting a new one**
6efe9c8 @sindresorhus Update install instructions
sindresorhus authored
23
fe3d0b9 @paulirish readme updates
paulirish authored
24
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This …
addyosmani authored
25 ## Documentation
26
27 Yeoman supports a powerful set of high-level commands. These include:
28
8f98e17 @paulirish more syntax highlighting
paulirish authored
29 ```shell
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This …
addyosmani authored
30 yeoman init # Initialize and scaffold a new project using generator templates
31 yeoman build # Build an optimized version of your app, ready to deploy
32 yeoman server # Launch a preview server which will begin watching for changes
c269e4c @paulmillr Update refs to mocha.
paulmillr authored
33 yeoman test # Run a Mocha test harness in a headless Phantom.js
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This …
addyosmani authored
34
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
35 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
36 yeoman uninstall # Uninstall the package
37 yeoman update # Update a package to the latest version
38 yeoman list # List the packages currently installed
39 yeoman search # Query the registry for matching package names
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
40 yeoman lookup # Look up info on a particular package
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This …
addyosmani authored
41
42 ```
43
44 A common initial workflow with Yeoman might be:
45
8f98e17 @paulirish more syntax highlighting
paulirish authored
46 ```shell
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
47 yeoman init # Invoke the most basic application scaffold (Bootstrap, Boilerplate etc.)
1a7395b @addyosmani Fixes #233 - updates references to build and intermediate dirs
addyosmani authored
48 yeoman build # Build your project, creating an optimized version in a new `dist` directory
49 yeoman server # Fire off a file watch/server process which also places an
50 # intermediate build of your project in `temp`
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This …
addyosmani authored
51 ```
52
53 Some more examples of how to use our commands include:
54
8f98e17 @paulirish more syntax highlighting
paulirish authored
55 ```shell
1a7395b @addyosmani Fixes #233 - updates references to build and intermediate dirs
addyosmani authored
56 # Generators for MVC/MV* Frameworks
a2b1c78 @addyosmani readme tweaks.
addyosmani authored
57 yeoman init quickstart # Skip our questions and get a H5BP, jQuery and Modernizr base
58 yeoman init bbb # Backbone Boilerplate generator scaffold
59 yeoman init ember # Ember-Rails generator scaffold
60 yeoman init backbone # Backbone-Rails generator scaffold
61
62 # Coming soon
63 yeoman init angular # Invoke the AngularJS generator scaffold
64 yeoman init angular:controller # Invoke the AngularJS Controller sub-generator
1a7395b @addyosmani Fixes #233 - updates references to build and intermediate dirs
addyosmani authored
65
66 # Generator for Chrome Apps
67 yeoman init chromeapps
68
69 # Package management
70 yeoman search jquery # Lookup jQuery in the Bower registry
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
71 yeoman install jquery underscore [depName] # Install a dependency or dependencies
72 yeoman update jquery # Update a specific dependency (e.g jquery)
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This …
addyosmani authored
73 ```
74
75
f565bca @addyosmani Updating references to docs, tweaking.
addyosmani authored
76 See the [complete documentation](https://github.com/yeoman/yeoman/tree/master/docs/cli) for more. 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
77
78
79
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored
80 ### Trouble-shooting
81
82 If for any reason you experience exceptions after the yeoman installation process above, you may find the
83 following steps resolve these issues:
84
8f98e17 @paulirish more syntax highlighting
paulirish authored
85 ```shell
86 cd yeoman/cli
87 sudo -s 'npm install -g && npm link'
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored
88 ```
fe3d0b9 @paulirish readme updates
paulirish authored
89
6b91fef @addyosmani Adding tweaks to contribution guide, disclaimer for private beta testers
addyosmani authored
90 Please also note that (pre-launch) commands such as `yeoman install`, `yeoman update` and `yeoman search` etc (i.e package management commands) will only work if you have [Bower](http://github.com/twitter/bower) installed. As this is also currently in private beta, please let us know if you need access and we'll sort that out.
eb655aa @addyosmani Adding note about bower access.
addyosmani authored
91
f565bca @addyosmani Updating references to docs, tweaking.
addyosmani authored
92 Should you run into any further problems beyond this, please open a [new issue](https://github.com/yeoman/yeoman/issues/new) and one of the team will be happy to follow up with you.
93
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
94
325ebaa @addyosmani Some more readme tweaks.
addyosmani authored
95
59c0d7f @addyosmani Adding browser support to README.
addyosmani authored
96 ## Browser Support
97
d063611 @sindresorhus Improve readme
sindresorhus authored
98 * Modern browsers (latest version of Chrome, Safari, Firefox, Opera and IE10)
59c0d7f @addyosmani Adding browser support to README.
addyosmani authored
99 * Chrome on Android
100 * Mobile Safari
101
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
102
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
103 ## Platform Support
104
6b91fef @addyosmani Adding tweaks to contribution guide, disclaimer for private beta testers
addyosmani authored
105 Yeoman 1.0 will support OS X and Linux. We will be aiming to bring in support for Windows in a future version of the project.
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
106
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
107 ## Contribute
108
6b91fef @addyosmani Adding tweaks to contribution guide, disclaimer for private beta testers
addyosmani authored
109 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.
110
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored
111 ### Repos
112
113 * [Yeoman (CLI, Insights)](http://github.com/yeoman/yeoman)
114 * [Yeoman I/O Holding Page](http://github.com/yeoman/yeoman.io)
d063611 @sindresorhus Improve readme
sindresorhus authored
115 * [Yeoman I/O Site](http://github.com/yeoman/yeoman.io) (site branch)
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored
116
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
117 ### Style Guide
118
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored
119 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.
120
b9fe2e5 @sindresorhus Make the CLI code pass JSHint
sindresorhus authored
121 ### Pull Request Guidelines
122
123 - Lint the code by running `grunt` in the `/cli` folder before submitting a pull request
124 - Develop in a topic branch, not master
125
987517f @paulirish update readme with testing info.
paulirish authored
126 ### Tests
127
128 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).
129
b4b6057 @paulirish readme update about testing
paulirish authored
130 To run our test suite:
131
132 ```sh
133 npm test
134 ```
135
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
136 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
137
d6c85b5 @paulirish add to readme about our existing developer documentation.
paulirish authored
138 ### Developer Docs
139
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
140 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
141
6b91fef @addyosmani Adding tweaks to contribution guide, disclaimer for private beta testers
addyosmani authored
142 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
143
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
144 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
145
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored
146 ## About
147
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
148 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:
149
150 * Twitter Bootstrap
d063611 @sindresorhus Improve readme
sindresorhus authored
151 * HTML5 Boilerplate
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
152 * Modernizr
153 * Twitter Bower
d063611 @sindresorhus Improve readme
sindresorhus authored
154 * Node.js
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
155 * NPM
156 * Compass
d063611 @sindresorhus Improve readme
sindresorhus authored
157 * Socket.IO
158 * CoffeeScript
159 * Mocha
160 * Jasmine
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
161 * PhantomJS
d063611 @sindresorhus Improve readme
sindresorhus authored
162 * And [more...](https://github.com/yeoman/yeoman/wiki/Dependencies)
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
163
164 Version 1 of the project features the combined efforts of:
165
d063611 @sindresorhus Improve readme
sindresorhus authored
166 * [Paul Irish](http://paulirish.com)
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
167 * [Addy Osmani](http://addyosmani.com)
d063611 @sindresorhus Improve readme
sindresorhus authored
168 * [Mickael Daniel](http://blog.mklog.fr)
169 * [Sindre Sorhus](http://sindresorhus.com)
8bc0352 @ebidel Update master
ebidel authored
170 * [Eric Bidelman](http://ericbidelman.com)
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored
171
d063611 @sindresorhus Improve readme
sindresorhus authored
172 and other developers.
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to re…
addyosmani authored
173
f565bca @addyosmani Updating references to docs, tweaking.
addyosmani authored
174 We will be aiming to officially release the project in Q3, 2012.
6b91fef @addyosmani Adding tweaks to contribution guide, disclaimer for private beta testers
addyosmani authored
175
176 ## Disclaimer
177
6efe9c8 @sindresorhus Update install instructions
sindresorhus authored
178 If you've been invited to try out the project as a beta tester or contributor, all we ask is that you refrain from publicly publishing/sharing the project sources until we have launched. This is to ensure that the first public version of Yeoman is as stable as possible, but would also stop unicorns from crying. Thanks for understanding :)
Something went wrong with that request. Please try again.