Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 167 lines (104 sloc) 7.147 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 relat...
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 relat...
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 relat...
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 easier...
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**
22
fe3d0b9 @paulirish readme updates
paulirish authored
23
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This is ...
addyosmani authored
24 ## Documentation
25
26 Yeoman supports a powerful set of high-level commands. These include:
27
8f98e17 @paulirish more syntax highlighting
paulirish authored
28 ```shell
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This is ...
addyosmani authored
29 yeoman init # Initialize and scaffold a new project using generator templates
30 yeoman build # Build an optimized version of your app, ready to deploy
31 yeoman server # Launch a preview server which will begin watching for changes
c269e4c @paulmillr Update refs to mocha.
paulmillr authored
32 yeoman test # Run a Mocha test harness in a headless Phantom.js
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This is ...
addyosmani authored
33
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
34 yeoman install # Install a package from the client-side package registry
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This is ...
addyosmani authored
35 yeoman uninstall # Uninstall the package
36 yeoman update # Update a package to the latest version
37 yeoman list # List the packages currently installed
38 yeoman search # Query the registry for matching package names
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
39 yeoman lookup # Look up info on a particular package
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This is ...
addyosmani authored
40
41 ```
42
43 A common initial workflow with Yeoman might be:
44
8f98e17 @paulirish more syntax highlighting
paulirish authored
45 ```shell
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
46 yeoman init # Invoke the most basic application scaffold (Bootstrap, Boilerplate etc.)
47 yeoman build # Build your project, creating an optimized version in the publish folder
48 yeoman server # Create an intermediate version of your app, firing off a watch process
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This is ...
addyosmani authored
49
50 ```
51
52 Some more examples of how to use our commands include:
53
8f98e17 @paulirish more syntax highlighting
paulirish authored
54 ```shell
1138522 @addyosmani Docs for #227
addyosmani authored
55 yeoman init angular # Invoke the AngularJS generator scaffold
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
56 yeoman init angular:controller # Invoke the AngularJS Controller sub-generator
1138522 @addyosmani Docs for #227
addyosmani authored
57 yeoman init bbb # Invoke the Backbone Boilerplate generator scaffold
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
58 yeoman install jquery underscore [depName] # Install a dependency or dependencies
59 yeoman update jquery # Update a specific dependency (e.g jquery)
60 yeoman search jquery # Lookup jquery in the Bower registry
f1f903c @addyosmani Adding usage examples and listing of commands for contributors. This is ...
addyosmani authored
61 ```
62
63
f565bca @addyosmani Updating references to docs, tweaking.
addyosmani authored
64 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 is ...
addyosmani authored
65
66
67
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
68 ### Trouble-shooting
69
70 If for any reason you experience exceptions after the yeoman installation process above, you may find the
71 following steps resolve these issues:
72
8f98e17 @paulirish more syntax highlighting
paulirish authored
73 ```shell
74 cd yeoman/cli
75 sudo -s 'npm install -g && npm link'
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
76 ```
fe3d0b9 @paulirish readme updates
paulirish authored
77
6b91fef @addyosmani Adding tweaks to contribution guide, disclaimer for private beta testers
addyosmani authored
78 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
79
f565bca @addyosmani Updating references to docs, tweaking.
addyosmani authored
80 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.
81
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
82
325ebaa @addyosmani Some more readme tweaks.
addyosmani authored
83
59c0d7f @addyosmani Adding browser support to README.
addyosmani authored
84 ## Browser Support
85
d063611 @sindresorhus Improve readme
sindresorhus authored
86 * Modern browsers (latest version of Chrome, Safari, Firefox, Opera and IE10)
59c0d7f @addyosmani Adding browser support to README.
addyosmani authored
87 * Chrome on Android
88 * Mobile Safari
89
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
90
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
91 ## Platform Support
92
6b91fef @addyosmani Adding tweaks to contribution guide, disclaimer for private beta testers
addyosmani authored
93 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
94
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
95 ## Contribute
96
6b91fef @addyosmani Adding tweaks to contribution guide, disclaimer for private beta testers
addyosmani authored
97 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.
98
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
99 ### Repos
100
101 * [Yeoman (CLI, Insights)](http://github.com/yeoman/yeoman)
102 * [Yeoman I/O Holding Page](http://github.com/yeoman/yeoman.io)
d063611 @sindresorhus Improve readme
sindresorhus authored
103 * [Yeoman I/O Site](http://github.com/yeoman/yeoman.io) (site branch)
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
104
c14bcac @sindresorhus Add mention about code style and fix indention of code blocks
sindresorhus authored
105 ### Style Guide
106
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
107 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.
108
b9fe2e5 @sindresorhus Make the CLI code pass JSHint
sindresorhus authored
109 ### Pull Request Guidelines
110
111 - Lint the code by running `grunt` in the `/cli` folder before submitting a pull request
112 - Develop in a topic branch, not master
113
987517f @paulirish update readme with testing info.
paulirish authored
114 ### Tests
115
116 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).
117
b4b6057 @paulirish readme update about testing
paulirish authored
118 To run our test suite:
119
120 ```sh
121 npm test
122 ```
123
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
124 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
125
d6c85b5 @paulirish add to readme about our existing developer documentation.
paulirish authored
126 ### Developer Docs
127
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
128 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
129
6b91fef @addyosmani Adding tweaks to contribution guide, disclaimer for private beta testers
addyosmani authored
130 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
131
b77cd39 @sindresorhus Cleanup readme
sindresorhus authored
132 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
133
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
134 ## About
135
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
136 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:
137
138 * Twitter Bootstrap
d063611 @sindresorhus Improve readme
sindresorhus authored
139 * HTML5 Boilerplate
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
140 * Modernizr
141 * Twitter Bower
d063611 @sindresorhus Improve readme
sindresorhus authored
142 * Node.js
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
143 * NPM
144 * Compass
d063611 @sindresorhus Improve readme
sindresorhus authored
145 * Socket.IO
146 * CoffeeScript
147 * Mocha
148 * Jasmine
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
149 * PhantomJS
d063611 @sindresorhus Improve readme
sindresorhus authored
150 * And [more...](https://github.com/yeoman/yeoman/wiki/Dependencies)
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
151
152 Version 1 of the project features the combined efforts of:
153
d063611 @sindresorhus Improve readme
sindresorhus authored
154 * [Paul Irish](http://paulirish.com)
8911835 @addyosmani Fixes #127 - improves credits in readme
addyosmani authored
155 * [Addy Osmani](http://addyosmani.com)
d063611 @sindresorhus Improve readme
sindresorhus authored
156 * [Mickael Daniel](http://blog.mklog.fr)
157 * [Sindre Sorhus](http://sindresorhus.com)
8bc0352 @ebidel Update master
ebidel authored
158 * [Eric Bidelman](http://ericbidelman.com)
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
159
d063611 @sindresorhus Improve readme
sindresorhus authored
160 and other developers.
f64ffb8 @addyosmani Updating project readme with troubleshooting for install, links to relat...
addyosmani authored
161
f565bca @addyosmani Updating references to docs, tweaking.
addyosmani authored
162 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
163
164 ## Disclaimer
165
6efe9c8 @sindresorhus Update install instructions
sindresorhus authored
166 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.