From ee1f86d2c13af09874178d75f773a37b11dbaa4c Mon Sep 17 00:00:00 2001 From: QWp6t Date: Thu, 28 Aug 2014 20:37:52 -0700 Subject: [PATCH 1/2] Adds Bower installation instructions --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8fa6f8c..4c61a05 100644 --- a/README.md +++ b/README.md @@ -61,13 +61,13 @@ Roots uses [Grunt](http://gruntjs.com/) for compiling LESS to CSS, checking for If you'd like to use Bootstrap Sass, look at the [Roots Sass](https://github.com/roots/roots-sass) fork. -### Install Grunt +### Install Grunt and Bower **Unfamiliar with npm? Don't have node installed?** [Download and install node.js](http://nodejs.org/download/) before proceeding. From the command line: -1. Install `grunt-cli` globally with `npm install -g grunt-cli`. +1. Install `grunt-cli` and `bower` globally with `npm install -g grunt-cli bower`. 2. Navigate to the theme directory, then run `npm install`. npm will look at `package.json` and automatically install the necessary dependencies. It will also automatically run `bower install`, which installs front-end packages defined in `bower.json`. When completed, you'll be able to run the various Grunt commands provided from the command line. From 76dff647318a247a53d29e42979d9728974be2a4 Mon Sep 17 00:00:00 2001 From: QWp6t Date: Thu, 28 Aug 2014 21:16:51 -0700 Subject: [PATCH 2/2] Adds notes about privileges. --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 4c61a05..56d3559 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,11 @@ From the command line: When completed, you'll be able to run the various Grunt commands provided from the command line. +**N.B.** +You will need write permission to the global npm directory to install `grunt-cli` and `bower`. You will also likely have to be using an elevated terminal or prefix the command with `sudo`, i.e., `sudo install -g grunt-cli bower`. + +We also advise against running as root user. NPM deliberately uses limited privileges when executing certain commands such as those included in the Roots post-install process, and when this happens to the root user, any file system objects that are not expressly writable by the root user will fail to write during the execution of the command. These might include directories such as `/var/www` or `/home/someotheruser`. If you're running as root and have problems, don't say we didn't warn you. + ### Available Grunt commands * `grunt dev` — Compile LESS to CSS, concatenate and validate JS