Skip to content

Commit

Permalink
Docs - added prerequisites
Browse files Browse the repository at this point in the history
When running `npm install` on a starter that uses native npm extensions via `node-gyp`, the user needs to know that they need `build-essentials`. A clean Ubuntu xenial install won't have it by default.

Closes #4121
  • Loading branch information
brainwipe authored Feb 19, 2018
1 parent c6fa2e1 commit c87765d
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/docs/gatsby-starters.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ This downloads the files and initializes the site by running `npm install`
If you don't specify a custom starter, your site will be created from the
[default starter](https://github.com/gatsbyjs/gatsby-starter-default).

## Prerequisites
Starters may use npm plugins that require [native node extensions](https://github.com/nodejs/node-gyp). For those to build, you will need to install `build-essential` from your package source.

For example, on Debian/Ubuntu:

`sudo apt-get install build-essential`

## Available Starters
There are several starters that have been created. Create a PR to include yours!

Official:
Expand Down

0 comments on commit c87765d

Please sign in to comment.