jrburke/almond — Issue #14: Clarify readme
Author: html5anchor
Created: 2012-02-13 20:47:29+00:00
State: open

Hi

There are some parts of the `readme` that confuse me. Could you clarify them either here or in the `readme` file itself?

### Restrictions

> - do not use packages/packagePaths config.

Does this mean I can't use any packages at all or just not use the `package` parameter when optimizing with `r.js`?

### Usage

> Run the optimizer using Node (also works in Java):
>	node r.js -o baseUrl=. name=path/to/almond.js include=main out=main-built.js wrap=true

How do I use Almond with an `app.build.js` file?
I.E. how do I transform `node ../../r.js -o app.build.js` (given under http://requirejs.org/docs/optimization.html#wholeproject) into the right command using `almond.js`?

Probably I wouldn't ask these questions if I was better at Node. Still, clear (and a bit of beginner) documentation is as important as good code to me.