readme.md

Welcome, Friend!

What am I?

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.

Yeoman is fast, performant and is optimized to work best in modern browsers.

Trouble-shooting

If for any reason you experience exceptions after the yeoman installation process above, you may find the
following steps resolve these issues:

cd yeoman/cli
sudo -s 'npm install -g && npm link'

Should you run into any further problems beyond this, please open a new issue and one of the team will be happy to follow up with you.

Bower

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 installed.

Because for the moment Twitter are publishing Bower over itself (for 1.0.0 release) you may need to run npm uninstall yeoman -g && npm install yeoman -g to get the latest install of Bower installed as a Yeoman dependency. This would be done if you wish to double-check an issue has been resolved with a more recent version.

As 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.

As Bower is also currently in private beta, please let us know if you need access and we'll sort that out.

Browser Support

Modern browsers (latest version of Chrome, Safari, Firefox, Opera and IE10)

Chrome on Android

Mobile Safari

Platform Support

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.

Contribute

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.

Repos

Style Guide

This project follows the jQuery Style Guide 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.

Pull Request Guidelines

Lint the code by running grunt in the /cli folder before submitting a pull request

Disclaimer

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 :)