Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document installation from source better #125

Merged
merged 1 commit into from
Mar 8, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 34 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,40 @@ Ultimately, it aims to support web extensions in a standard, portable,
cross-platform way. Initially, it will provide a streamlined experience for developing
[Firefox web extensions](https://developer.mozilla.org/en-US/Add-ons/WebExtensions).

## Installation
## Installation from npm

This tool is not yet ready for installation. Stay tuned.
This tool has not yet been released on npm. Stay tuned.

## Installation from source

You'll need:
* [Node.js](https://nodejs.org/en/), 0.12 or higher
* [npm](https://www.npmjs.com/), 3.x or higher

Optionally, you may like:
* [nvm](https://github.com/creationix/nvm), which helps manage node versions

Make sure `npm` is up to date:

npm install -g npm

Change into the source and install everything:

git clone https://github.com/mozilla/web-ext.git
cd web-ext
npm install

Build the command:

npm run build

Link it to your node installation:

npm link

You can now run it from any directory:

web-ext --help

## Should I Use It?

Expand All @@ -33,11 +64,7 @@ Read on for how to develop new features.

## Development of web-ext

You'll need:
* [Node.js](https://nodejs.org/en/), 0.12 or higher
* [npm](https://www.npmjs.com/) installed globally

To get started, clone the source and run `npm install`.
To get started, first install it from source as documented above.

## Develop all the things

Expand Down