Skip to content
Browse files

Updating project readme with troubleshooting for install, links to re…

…lated repos for the project, other updates.
  • Loading branch information...
1 parent 13ecf21 commit f64ffb859157c2c1fd75f6584843272d14546fec @addyosmani addyosmani committed Jun 26, 2012
Showing with 41 additions and 3 deletions.
  1. +41 −3 readme.md
View
44 readme.md
@@ -6,15 +6,31 @@ Yeoman is a robust and opinionated client-side stack, comprised of tools and fra
Yeoman is fast, performant and is optimized to work best in modern browsers.
+For more information about the project, see [http://yeoman.io](http://yeoman.io).
+
## Installing
+* Clone this repo and `cd` into it
+* Run the following command at the terminal:
+
```shell
./setup/install.sh
```
+* Navigate to a new directory and run `yeoman init` to make sure everything is working as expected.
-Oh. That's it.
+### 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
@@ -46,7 +62,7 @@ For example, run this guy as:
## Documentation
-The current documentation for Yeoman can be found [here](http://yeoman.github.com/docs).
+The current documentation for Yeoman can be found [here](http://yeoman.github.com/docs). If you are a new contributor and require access to this repository, feel free to ask.
## Browser Support
@@ -60,6 +76,28 @@ Yeoman supports:
## Contribute
+### Repos
+
+* [Yeoman (CLI, Insights)](http://github.com/yeoman/yeoman)
+* [Yeoman I/O Holding Page](http://github.com/yeoman/yeoman.io)
+* [Yeoman I/O Site](http://github.com/yeoman/yeoman.io)(site branch)
+* [Yeoman Docs](http://github.com/yeoman/docs)
+
### Style Guide
-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.
+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.
+
+## 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.
+

0 comments on commit f64ffb8

Please sign in to comment.
Something went wrong with that request. Please try again.