README.md in iruby-0.2.7 vs README.md in iruby-0.2.8
- old
+ new
@@ -5,36 +5,109 @@
This is a Ruby kernel for IPython/Jupyter and is part of [SciRuby](http://sciruby.com/). You can try it at [try.jupyter.org](http://try.jupyter.org/).
### Quick start
+The installation instructions are divided according to environments mainly because of ZeroMQ.
+#### Ubuntu/Debian
At first install IPython/Jupyter. I recommend an installation using virtualenv.
apt-get install python3-dev virtualenv libzmq3-dev
virtualenv -p python3 venv
source venv/bin/activate
pip install 'ipython[notebook]'
After that, install the Ruby gem.
+ gem install rbczmq
gem install iruby
Now you can run iruby with:
- iruby
iruby notebook
+#### Windows
+At first install IPython/Jupyter. I recommend an installation using [Enthought Canopy](https://www.enthought.com/).
+
+After that install libzmq.dll (v3.2.x, x86) from [the website of ZeroMQ](http://zeromq.org/area:download).
+
+Rename `libzmq-v100-mt-3_x_x.dll` to `libzmq.dll`.
+
+Add the path to /bin to the PATH system variable.
+
+Run two commands below:
+
+ gem install ffi-rzmq
+ gem install iruby
+
+Now you can run iruby with:
+
+ iruby notebook
+
+#### Mac
+I recommend an installation using [Anaconda](https://store.continuum.io/cshop/anaconda/).
+I have not checked the installation to MacOS X, but four lines below were necessary in v0.1.x.
+
+ conda remove zeromq (If you installed anaconda)
+ brew install zeromq
+ gem install ffi-rzmq
+ gem install iruby
+
+Send us pull-request if you Mac users successed in installing IRuby in another way.
+
+#### FreeBSD
+
+At first install IPython/Jupyter.
+There is a pyzmq ports (ports/net/py-pyzmq) which depends on libzmq4, however, it doesn't works with ipython.
+Therefore we use libzmq3 like the following:
+
+1. make your ports tree up-to-date.
+2. replace LIBDEPENDS line in ports/net/py-pyzmq/Makefile
+
+ ```shell
+ LIB_DEPENDS= libzmq.so:${PORTSDIR}/net/libzmq4
+ ```
+ with
+ ```shell
+ LIB_DEPENDS= libzmq.so:${PORTSDIR}/net/libzmq3
+ ```
+3. install related packages
+
+ ```shell
+ $ sudo pkg install libzmq3 py27-qt4-gui py27-pexpect-3.3 py27-qt4-svg py27-pygments py27-Jinja2 py27-tornado py27-jsonschema
+ ```
+4. make install using ports
+
+ ```shell
+ $ cd /usr/ports/net/py-pyzmq
+ $ sudo make install
+ $ cd /usr/ports/devel/ipython
+ $ sudo make install
+ ```
+Then, install iruby and related ports and gems.
+ ```shell
+ $ sudo pkg install rubygem-mimemagic
+ $ sudo gem install ffi-rzmq # install ffi, ffi-rzmq-core and ffi-rzmq
+ $ git clone https://github.com/SciRuby/iruby.git
+ $ cd iruby
+ $ gem build iruby.gemspec
+ $ sudo gem install iruby-0.2.7.gem
+ ```
+
+### After the installation
+
Take a look at the [example notebook](http://nbviewer.ipython.org/urls/raw.github.com/SciRuby/sciruby-notebooks/master/getting_started.ipynb)
and the [collection of notebooks](https://github.com/SciRuby/sciruby-notebooks/) which includes a Dockerfile to create a containerized installation of iruby
and other scientific gems. You can find the prebuild image at [dockerhub](https://registry.hub.docker.com/u/minad/sciruby-notebooks/).
### Required dependencies
* IPython/Jupyter >= 3.0.0
-* libzmq >= 3.2
* Ruby >= 2.1.0
+
+If you install IRuby with ffi-rzmq instead of rbczmq, libzmq >= 3.2 is added to the list above.
### Authors
See the [CONTRIBUTORS](CONTRIBUTORS) file.