Skip to content

Commit

Permalink
Fixes #233 - updates references to build and intermediate dirs
Browse files Browse the repository at this point in the history
  • Loading branch information
addyosmani committed Aug 22, 2012
1 parent 6da5e84 commit 1a7395b
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/cli/build.md
Expand Up @@ -17,7 +17,7 @@ These include:
* Creating an Application Cache manifest via Confess.js
* Using revision filenames or oldernames

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.
When you run `yeoman server`, we generate an intermediate build directory called `temp`, 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 `dist` directory which has completely optimized version of your application that can be deployed to staging.

### Build targets

Expand Down
4 changes: 2 additions & 2 deletions docs/cli/server.md
Expand Up @@ -13,8 +13,8 @@ Any changes to CoffeeScript or Compass files result in them being recompiled, me
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.
`yeoman server` generates an intermediate build directory in your project root which (called `temp`)
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
Expand Down
14 changes: 11 additions & 3 deletions readme.md
Expand Up @@ -44,20 +44,28 @@ A common initial workflow with Yeoman might be:

```shell
yeoman init # Invoke the most basic application scaffold (Bootstrap, Boilerplate etc.)
yeoman build # Build your project, creating an optimized version in the publish folder
yeoman server # Create an intermediate version of your app, firing off a watch process
yeoman build # Build your project, creating an optimized version in a new `dist` directory
yeoman server # Fire off a file watch/server process which also places an
# intermediate build of your project in `temp`

```

Some more examples of how to use our commands include:

```shell
# Generators for MVC/MV* Frameworks
yeoman init angular # Invoke the AngularJS generator scaffold
yeoman init angular:controller # Invoke the AngularJS Controller sub-generator
yeoman init bbb # Invoke the Backbone Boilerplate generator scaffold
yeoman init ember # Invoke the Ember generator scaffold

# Generator for Chrome Apps
yeoman init chromeapps

# Package management
yeoman search jquery # Lookup jQuery in the Bower registry
yeoman install jquery underscore [depName] # Install a dependency or dependencies
yeoman update jquery # Update a specific dependency (e.g jquery)
yeoman search jquery # Lookup jquery in the Bower registry
```


Expand Down

0 comments on commit 1a7395b

Please sign in to comment.