Skip to content

Commit

Permalink
Clarifcations in tools README
Browse files Browse the repository at this point in the history
  • Loading branch information
wch committed Mar 31, 2015
1 parent 982a436 commit babc59f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ This directory contains build tools for Shiny.

## Grunt

Grunt is a build tool that runs on node.js. In Shiny, it is used for minifying and linting Javascript code.
Grunt is a build tool that runs on node.js. In Shiny, it is used for concatenating, minifying, and linting Javascript code.

### Installing Grunt

Expand All @@ -21,7 +21,7 @@ npm install

### Using Grunt

To run all default grunt tasks (minification and jshint), simply go into the `tools` directory and run:
To run all default grunt tasks (concatenation, minification, and jshint), simply go into the `tools` directory and run:

```
grunt
Expand All @@ -33,6 +33,6 @@ It's also useful to run `grunt` so that it monitors files for changes and run ta
grunt watch
```

One of the tasks minifies `shiny.js` to generate `shiny.min.js`. The minified file is supplied to the browser, along with a source map file, `shiny.min.js.map`, which allows a user to view the original Javascript source when using the debugging console in the browser.
One of the tasks concatenates all the .js files in `/srcjs` together into `/inst/www/shared/shiny.js`. Another task minifies `shiny.js` to generate `shiny.min.js`. The minified file is supplied to the browser, along with a source map file, `shiny.min.js.map`, which allows a user to view the original Javascript source when using the debugging console in the browser.

During development of Shiny's Javascript code, it's best to use `grunt watch` so that the minified file will get updated whenever you make changes to `shiny.js`.
During development of Shiny's Javascript code, it's best to use `grunt watch` so that the minified file will get updated whenever you make changes the Javascript sources.

0 comments on commit babc59f

Please sign in to comment.