Permalink
Browse files

Expanding on the docs further.

  • Loading branch information...
1 parent 80bb000 commit 030481d39005e0b9b3fb022b106b7037dcacece6 @addyosmani addyosmani committed Aug 6, 2012
Showing with 72 additions and 16 deletions.
  1. +8 −4 docs/cli/build.md
  2. +1 −1 docs/cli/generators.md
  3. +1 −1 docs/cli/help.md
  4. +2 −3 docs/cli/init.md
  5. +2 −0 docs/cli/requirements.md
  6. +9 −4 docs/cli/server.md
  7. +22 −1 docs/cli/test.md
  8. +27 −2 docs/cli/uninstall.md
View
@@ -2,9 +2,9 @@
Usage: `yeoman build`, `yeoman build:<target>`
-Yeoman leverages third party tools to construct an optimized version of your application that's ready to deploy.
+Constructs an optimized version of your application that's ready to deploy.
-We make use of [Grunt](https://github.com/cowboy/grunt) behind the scenes to tackle much of the hard work for this, with some useful additions that assist with compression, optimization and testing.
+Yeoman makes use of [Grunt](https://github.com/cowboy/grunt) behind the scenes to tackle much of the hard work for this, with some useful additions that assist with compression, optimization and testing.
These include:
@@ -17,8 +17,9 @@ These include:
* Creating an Application Cache manifest via Confess.js
* Using revision filenames or oldernames
-We finally publish an optimized version of your application to your project directory
-so that it can be deployed to production right after.
+When you run `yeoman server`, we generate an `intermediate` build directory for your project, containing compiled versions of your Compass and CoffeeScript files as well as all of the other files needed to preview your application. Running `yeoman build` creates a `publish` directory which has completely optimized version of your application that can be deployed to staging.
+
+### Build targets
Yeoman supports a number of build targets to be used with `yeoman build`. To implicitly
pass the `default` target one would run `yeoman build:default` for example. The complete
@@ -30,6 +31,9 @@ list of supported build targets can be found below:
* basics: Runs `concat css min img rev usemin manifest html:basics`
* minify: Runs `concat css min img rev usemin manifest html:compress`
+
+### Sub-tasks
+
Each build target above runs a number of different build *tasks*. The supported
tasks included with Yeoman out of the box are:
View
@@ -1,6 +1,6 @@
## Generators
-Yeoman generators allow you to scaffold out a project using a custom setup of boilerplates,
+Generators allow you to scaffold out a project using a custom setup of boilerplates,
frameworks and dependencies. These are wrapped up in a generator (or scaffold). The basic
application generated when calling `yeoman init` actually uses a generator itself and they
can be quite powerful.
View
@@ -3,7 +3,7 @@
* `yeoman --help` or `yeoman help`
-This will list out the commands and tasks supported by yeoman and should print out the following to the console:
+Lists out the commands and tasks supported by yeoman and should print out the following to the console:
```shell
yeoman init # Initialize and scaffold a new project using generator templates
View
@@ -3,9 +3,8 @@
Usage: `yeoman init`, `yeoman init generatorName`, `yeoman init generatorName:subgenerator`
-The `init` command allows you to kick-start a new project by asking a number of questions
-about what you would like to include. These answers are used to scaffold out a file structure
-for your new application.
+Helps you kick-start a new web application by asking a number of questions about what you would like to include.
+These answers are used to scaffold out a file structure for your project.
The default init template is based on:
View
@@ -12,3 +12,5 @@ You should be able to use it on:
* OSX
* Unix
+Note that dependencies we pull in for the command-line portion of the project are listed in our
+[package.json](https://github.com/yeoman/yeoman/blob/master/cli/package.json) file.
View
@@ -2,15 +2,20 @@
Usage: `yeoman server`
-The `server` command launches a preview server on port 3051 that allows you to access a running
-version of your application locally.
+Launches a preview server on port 3051 that allows you to access a running version of your application
+locally.
-It also automatically fires up the `yeoman server` process, so changes to any of the applications
-files cause the browser to refresh via LiveReload.
+It also automatically fires up the `yeoman watch` process, so changes to any of the applications
+files cause the browser to refresh via [LiveReload](http://livereload.com). Should you not have
+LiveReload installed locally, a fallback reload process will be used instead.
Any changes to CoffeeScript or Compass files result in them being recompiled, meaning that
no manual intervention is required to write and preview code in the format you feel most
comfortable with.
+`yeoman server` generates an intermediate build directory in your project root which contains
+the compiled files mentioned above as well as the basic blocks needed to preview your application.
+A complete build can be generated using `yeoman build`.
+
To quit the server, simply run `yeoman quit server` and this will kill the Python server
process.
View
@@ -2,4 +2,25 @@
Usage: `yeoman test`
-This command runs a Jasmine test harness in a headless instance of Phantom.js.
+Runs a Jasmine test harness in a headless instance of Phantom.js.
+
+When you generate a new project using `yeoman init`, we also scaffold out a basic set of
+Jasmine unit tests that you can continue using to test your application.
+
+Running `yeoman test` allows you to easily check if all of your tests are passing. This also
+gets called when running `yeoman build`.
+
+Example:
+
+```shell
+yeoman test
+
+# outputs:
+
+Running "jasmine:all" (jasmine) task
+Running specs for index.html
+.....................................................
+>> 82 assertions passed in 53 specs (562ms)
+
+Done, without errors.
+```
View
@@ -1,6 +1,31 @@
## uninstall
-Usage: yeoman uninstall <name>
+Usage: yeoman uninstall <packageName>
-Removes the package <name> from the current project.
+Removes the package <packageName> from the current project.
+
+Example:
+
+```shell
+yeoman uninstall backbone
+
+# outputs:
+
+bower uninstalling /project/browser_modules/backbone
+```
+
+Note: If you attempt to uninstall a package that is a dependency of other packages, yeoman (via Bower)
+will throw an error.
+
+Example:
+
+```shell
+yeoman uninstall jquery
+
+# outputs:
+warning backbone depends on jquery
+```
+
+This simply means that you should uninstall backbone (the top-level package with the dependency) if you
+wish to remove all traces of the jquery package.

0 comments on commit 030481d

Please sign in to comment.