Skip to content

Commit

Permalink
Updating some docs to make them more awesome.
Browse files Browse the repository at this point in the history
  • Loading branch information
cowboy committed Mar 23, 2012
1 parent 1599f62 commit 59f8578
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 17 deletions.
12 changes: 6 additions & 6 deletions README.md
Expand Up @@ -4,7 +4,7 @@ Grunt is a task-based command line build tool for JavaScript projects.
_Grunt is currently in beta. While I'm already using it on multiple projects, it might have a minor issue or two. And things might change before its final release, based on your feedback. Please try it out in a project, and [make suggestions][issues] or [report bugs][issues]!_

## Getting started
Be sure to read the [getting started guide](/cowboy/grunt/blob/master/docs/getting_started.md), which is a complete guide to configuring grunt for your project. In addition, check out the [example gruntfiles](/cowboy/grunt/blob/master/docs/example_gruntfiles.md) which contains a few samples.
Be sure to read the [getting started guide](/cowboy/grunt/blob/master/docs/getting_started.md), which is a complete guide to configuring grunt for your project. In addition, check out the [example gruntfiles](/cowboy/grunt/blob/master/docs/example_gruntfiles.md) which highlight a number of fairly common configurations.

## Built-in tasks
As of now, grunt has the following predefined tasks that you can use in your project:
Expand All @@ -18,6 +18,8 @@ As of now, grunt has the following predefined tasks that you can use in your pro
* test - Run unit tests with [nodeunit][nodeunit].
* watch - Run predefined tasks whenever watched files change.

_(More documentation forthcoming)_

## Custom tasks
In addition to the built-in tasks, you can create your own tasks. Don't like a built-in task's default behavior? Override it. Check out the [grunt API documentation](/cowboy/grunt/blob/master/docs/api.md) and the [built-in tasks source](/cowboy/grunt/blob/master/tasks) for everything you need to know about creating custom tasks.

Expand All @@ -31,13 +33,11 @@ Being primarily a JavaScript developer, I decided to use [Node.js][node] and [np

## Installing grunt

Grunt is available as an [npm][npm] module. If you install grunt globally via `npm install -g grunt`, it will be available for use in all of your projects.

Once grunt has been installed, you can type `grunt --help` at the command line for more information. And if you want to see grunt "grunt" itself, cd into grunt's directory and type `grunt`
Grunt is available as an [npm][npm] module. If you install grunt globally via `npm install -g grunt`, it will be available for use in all of your projects. Once grunt has been installed, you can type `grunt --help` at the command line for more information. And if you want to see grunt "grunt" itself, cd into grunt's directory and type `grunt`

_Note: in Windows, you may need to run grunt as `grunt.cmd`._
_Note: in Windows, you may need to run grunt as `grunt.cmd`. See the [FAQ](/cowboy/grunt/blob/master/docs/faq.md) for more Windows-specific information._

For projects already using grunt, you're done. Otherwise, if you're starting from scratch, check out the [init task](/cowboy/grunt/blob/master/docs/task_init.md), which will set up a new grunt-based project for you. Even if you don't ultimately use the files that are generated, you can very quickly learn how grunt works.
For projects already using grunt, you're done. Otherwise, if you're adding grunt to an existing project or starting from scratch, check out the [getting started guide](/cowboy/grunt/blob/master/docs/getting_started.md), which is a complete guide to configuring grunt for your project.

## Release History
_(Until v1.0.0, this will only be updated when major or breaking changes are made)_
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
@@ -1 +1 @@
View the [Documentation table of contents](https://github.com/cowboy/grunt/blob/master/docs/toc.md).
[Grunt homepage](https://github.com/cowboy/grunt) | [Documentation table of contents](/cowboy/grunt/blob/master/docs/toc.md)
14 changes: 5 additions & 9 deletions docs/contributing.md
Expand Up @@ -10,36 +10,32 @@ Join the [freenode](http://freenode.net/) #grunt IRC channel. We've got a bot an

## Filing issues

If something isn't working like you think it should, read the documentation. If it still isn't working like you think it should, [file an issue](https://github.com/cowboy/grunt/issues). If you'd like to chat directly, pop into IRC.
If something isn't working like you think it should, read the [API documentation](api.md). If it still isn't working like you think it should, [file an issue](https://github.com/cowboy/grunt/issues). If you'd like to chat directly, pop into IRC.

## Cloning grunt

Ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed.
first, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed.

Fork grunt in GitHub, and clone it locally:

```bash
git clone git://github.com/YOURUSERNAME/grunt.git && cd grunt
```

To download grunt dependencies and add the development `grunt` script to your path:
To download grunt dependencies and add the development `grunt` bin script to your path:

```bash
npm install && npm link
```

## Reverting back to production grunt
## Reverting back to the "live" grunt

If, for some reason, you need to revert back to the official grunt release, this will ensure that the `grunt` script links to the globally installed production release:
If, for some reason, you need to revert back to the current npm grunt release, just reinstall grunt globally via:

```bash
npm install -g grunt
```

## Devloping grunt plugins

_(Coming soon)_

## Actually contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Fork, tweak, and make pull requests.. but `grunt` grunt first:
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins.md
Expand Up @@ -2,4 +2,4 @@

# Plugins

_(coming soon)_
_(This section is coming soon. Probably around v0.3.1 or so)_

0 comments on commit 59f8578

Please sign in to comment.