Permalink
Browse files

Adding FAQ entry about using devel version.

  • Loading branch information...
1 parent 664963c commit 9c46ed538b31253878c526365fa027f0bdc7b54f @cowboy committed Aug 3, 2012
Showing with 9 additions and 0 deletions.
  1. +9 −0 docs/faq.md
View
9 docs/faq.md
@@ -2,6 +2,15 @@
# Frequently Asked Questions
+## When will I be able to use in-development feature 'X'? <a name="when-will-i-be-able-to-use-in-development-feature-x" href="#when-will-i-be-able-to-use-in-development-feature-x" title="Link to this section">⚑</a>
+While critical bug fixes are applied to both the latest stable release as well as the in-development version of grunt, new features are usually only added to the in-development version.
+
+If you want to install the latest bleeding-edge, in-development version, you can npm install `grunt@devel`. _This is something you do not want to do in a project_, as the in-development version of grunt is constantly evolving and a feature you've come to depend on may have changed between installs of `grunt@devel`, thus breaking your build.
+
+If you want to install an in-development version of grunt, locked in at a specific commit (totally fine for projects), follow the instructions for specifying a [git URL as a dependency](https://npmjs.org/doc/json.html#Git-URLs-as-Dependencies), and be sure to specify an actual commit SHA (not a branch name) as the `commit-ish`.
+
+Finally, it is preferable to specify grunt as a [devDependency](https://npmjs.org/doc/json.html#devDependencies) in your project's [package.json](https://npmjs.org/doc/json.html) and instruct users to do `npm install` than to have them install grunt explicitly with `npm install grunt`. This makes the task of installing grunt (and any other dev dependencies) much easier and less error-prone.
+
## On Windows, why does my JS editor open when I try to run grunt? <a name="on-windows-why-does-my-js-editor-open-when-i-try-to-run-grunt" href="#on-windows-why-does-my-js-editor-open-when-i-try-to-run-grunt" title="Link to this section">⚑</a>
If you're in the same directory as the [grunt.js gruntfile](getting_started.md), Windows tries to execute _that file_ when you type grunt. So you need to type `grunt.cmd` instead.

0 comments on commit 9c46ed5

Please sign in to comment.