From b82692b2bf328c6c0c8ecce1e872625f62bae122 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Fri, 26 Jul 2013 14:09:12 -0700 Subject: [PATCH] more readme love --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index fcd174ff78..5ce450d7ee 100644 --- a/README.md +++ b/README.md @@ -47,20 +47,20 @@ Documentation for v2.3.3 has been made available for the time being at [http://g ## Compiling CSS and JavaScript -Bootstrap uses [Grunt](http://gruntjs.com/) with convenient methods for working with the framework. Before getting started, be sure to have `grunt-cli` installed globally (`npm install -g grunt-cli`) and then install [the necessary local dependencies](package.json): +Bootstrap uses [Grunt](http://gruntjs.com/) with convenient methods for working with the framework. It's how we compile our code, run tests, and more. To use it, install the required dependencies as directed and then run some Grunt commands. -``` -# if grunt-cli isn't already installed -$ npm install -g grunt-cli +### Install Grunt -$ npm install -``` +From the command line: -When completed, you'll be able to run the various grunt commands provided. +1. Install `grunt-cli` globally with `npm install -g grunt-cli`. +2. Install the [necessary local dependencies](package.json) via `npm install` + +When completed, you'll be able to run the various Grunt commands provided. **Unfamiliar with `npm`? Don't have node installed?** That's a-okay. npm stands for [node packaged modules](http://npmjs.org/) and is a way to manage development dependencies through node.js. [Download and install node.js](http://nodejs.org/download/) before proceeding. -### Available grunt commands +### Available Grunt commands #### Build - `grunt` `grunt` runs the Recess compiler to rebuild the `/less` files and compile the docs. **Requires recess and uglify-js.** @@ -76,7 +76,7 @@ This is a convenience method for watching just Less files and automatically buil ### Troubleshooting dependencies -Should you encounter problems with installing dependencies or running grunt commands, uninstall all previous dependency versions (global and local). Then, rerun `npm install`. +Should you encounter problems with installing dependencies or running Grunt commands, uninstall all previous dependency versions (global and local). Then, rerun `npm install`.