Skip to content

Commit

Permalink
doc: Update installation instructions
Browse files Browse the repository at this point in the history
* OS X: Added `pkg-config`.

* Added instruction specific to Windows.
  • Loading branch information
n-riesco committed Jun 21, 2015
1 parent 317875e commit 71308e8
Showing 1 changed file with 24 additions and 8 deletions.
32 changes: 24 additions & 8 deletions doc/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
The instructions to install IJavascript are platform-dependent and very much
determined by the following dependencies:

- [IPython notebook](http://ipython.org/notebook.html)
- [ZeroMQ](http://zeromq.org/)
- [Node.js](http://nodejs.org/)
- [npm](https://www.npmjs.com/)
- [node.js](http://nodejs.org/)
- [IPython notebook](http://ipython.org/notebook.html)

## Debian and Ubuntu

Expand Down Expand Up @@ -44,14 +44,14 @@ But note that the above command will install the executable `ijs` in the folder
`~/node_modules/.bin/` and you may want to add this folder to your `PATH`:

```sh
echo \"PATH=\"\$HOME/node_modules/.bin\" >> ~/.profile
echo \"PATH=\"\$HOME/node_modules/.bin:\$PATH\" >> ~/.profile
```

The above change won't take effect until you log out of the current session.

### Ubuntu 12.04

To install IJavascript in Ubuntu 12.04, both `node.js` and `ipython` need
To install IJavascript in Ubuntu 12.04, both `Node.js` and `IPython` need
upgrading to a recent version. You can do so by running:

```sh
Expand All @@ -66,23 +66,39 @@ The instructions for upgrading `node.js` have been adapted from those found

## OS X

I don't have access to any OS X machine, but I have been told that
I don't have access to a OS X machine, but I have been told that
[Homebrew](http://brew.sh/) may help with the installation of the IJavascript
dependencies in OS X. I would be grateful if OS X users could confirm the
instructions below work as intended:

```sh
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install node
brew install zeromq
brew install pkg-config node zeromq
sudo easy_install pip
sudo pip install --upgrade ipython jinja2 tornado jsonschema pyzmq
```

Once the dependencies have been installed, `npm` can be used to install
IJavascript as described above in the section for Ubuntu and Debian.

## Windows and other platforms
## Windows

`IPython` could be installed following the instructions at
[ipython.org/install](http://ipython.org/install.html). I find more convenient
to install a Python distribution such as `Anaconda`; see
[here](http://continuum.io/downloads). `Anaconda` not only installs `IPython`
and its requirements, but also a selection of frequently-used Python packages.

`Node.js` provides a [Windows installer](https://nodejs.org/download/). However,
the build tool `node-gyp` will not be functional unless one of the recognised
C++ compilers is installed. See [here](https://github.com/TooTallNate/node-gyp)
for more details,
[here](http://www.microsoft.com/en-us/download/details.aspx?id=34673) for Visual
Studio Express 2012 or
[here](https://www.visualstudio.com/products/visual-studio-express-vs) for a
link to Visual Studio Express 2013.

## Other platforms

For other platforms, instructions to install the IJavascript dependencies may be
found at [nodejs.org/download](http://nodejs.org/download/),
Expand Down

1 comment on commit 71308e8

@rgbkrk
Copy link
Contributor

@rgbkrk rgbkrk commented on 71308e8 Jul 19, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Please sign in to comment.