yeoman - lukegb/yeoman GitHub Wiki

yeoman(1) -- Yeoman CLI tool

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.

For more information about the project, see http://yeoman.io.

Installing

  • Clone this repo and cd into it
  • Run the following command at the terminal:
./setup/install.sh
  • Navigate to a new directory and run yeoman init to make sure everything is working as expected.

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 npm install -g
# when complete then run..
$ sudo npm link

Running

Here's a small shell script that you can save as server.sh which opens and servers the current directory on the port specified:

port=$1
if [ $#  -ne  1 ]
then
  port=8000
fi

if [ $(uname -s) == "Darwin" ]
then
  open=open
else
  open=xdg-open
fi

$open http://localhost:$port && python -m SimpleHTTPServer $port;

For example, run this guy as:

./server.sh 8000

Documentation

The current documentation for Yeoman can be found here. If you are a new contributor and require access to this repository, feel free to ask.

Browser Support

Yeoman supports:

  • Modern browsers (latest versions of Chrome, Safari, Firefox, Opera and IE10)
  • Chrome on Android
  • Mobile Safari

Contribute

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.

About

Yeoman is an open-source project by Google which builds on top of a number of open-source solutions. These include Grunt, Twitter Bootstrap and Compass. Version 1 of the project features the combined efforts of:

  • Paul Irish
  • Addy Osmani
  • Mickael Daniel
  • Sindre Sorhus
  • Eric Bidelman

and other developers.

We will be aiming to officially release the project in late July, 2012.