README.md in iruby-0.3 vs README.md in iruby-0.4.0
- old
+ new
@@ -1,134 +1,165 @@
-***The current master branch and gem version >= 0.2 are compatible with IPython3/Jupyter. If you require IPython2 support, please install an older gem version < 0.2 or use the branch ipython2***
-
# IRuby
-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/).
+[](https://badge.fury.io/rb/iruby)
+[](https://travis-ci.org/SciRuby/iruby)
+[](https://mybinder.org/v2/gh/RubyData/binder/master?filepath=ruby-data.ipynb)
-
+IRuby is a Ruby kernel for [Jupyter project](http://try.jupyter.org/).
-### Quick start
-The installation instructions are divided according to environments mainly because of ZeroMQ.
+## Installation
+How to set up [ZeroMQ](http://zeromq.org/) depends on your environment.
+You can use one of the following libraries.
+* [CZTop](https://gitlab.com/paddor/cztop) and [CZMQ](https://github.com/zeromq/czmq) >= 4.0.0
+* [ffi-rzmq](https://github.com/chuckremes/ffi-rzmq) and [libzmq
+](https://github.com/zeromq/libzmq) >= 3.2
-#### Ubuntu/Debian
-At first install IPython/Jupyter. I recommend an installation using virtualenv.
+### Ubuntu
+Install Jupyter with [Anaconda](https://www.anaconda.com/) (recommended).
- sudo apt-get install python3-dev python-virtualenv
- virtualenv -p python3 venv
- source venv/bin/activate
- pip install 'ipython[notebook]'
+#### Setup ZeroMQ on Ubuntu 16.04
+CZTop requires CZMQ >= 4.0.0 and ZMQ >= 4.2.0. The official packages for Ubuntu 16.04 don't satisfy these version requrements, so you need to install from source.
-After that, install the Ruby gem.
+```shell
+sudo apt install libtool libffi-dev ruby ruby-dev make
+sudo apt install git libzmq-dev autoconf pkg-config
+git clone https://github.com/zeromq/czmq
+cd czmq
+./autogen.sh && ./configure && sudo make && sudo make install
+```
- gem install cztop
- gem install iruby
+#### Setup ZeroMQ on Ubuntu 17.04 to 18.10
+Use official packages.
-Now you can run iruby with:
+```shell
+sudo apt install libtool libffi-dev ruby ruby-dev make
+sudo apt install libzmq3-dev libczmq-dev
+```
- iruby notebook
+#### Install CZTop and IRuby
+```shell
+gem install cztop
+gem install iruby --pre
+iruby register --force
+```
-#### Windows
-At first install IPython/Jupyter. I recommend an installation using [Enthought Canopy](https://www.enthought.com/).
+### Windows
+Install git and Jupyter with [Anaconda](https://www.anaconda.com/) (recommended).
+[DevKit](https://rubyinstaller.org/add-ons/devkit.html) is necessary for building RubyGems with native C-based extensions.
-Run two commands below:
+Install ZeroMQ.
+```shell
+pacman -S mingw64/mingw-w64-x86_64-zeromq
+```
- gem install cztop
- gem install iruby
+```shell
+gem install ffi-rzmq
+gem install iruby --pre
+iruby register --force
+```
-Now you can run iruby with:
+### macOS
+Install ruby with rbenv or rvm.
+Install Jupyter with [Anaconda](https://www.anaconda.com/) (recommended).
- iruby notebook
+#### Homebrew
+```shell
+brew install automake gmp libtool wget
+brew install zeromq --HEAD
+brew install czmq --HEAD
+```
-#### Mac
-I recommend an installation using [Anaconda](https://store.continuum.io/cshop/anaconda/).
+```shell
+# export LIBZMQ_PATH=$(brew --prefix zeromq)/lib
+# export LIBCZMQ_PATH=$(brew --prefix czmq)/lib
+# gem install cztop
+gem install ffi-rzmq
+gem install iruby --pre
+iruby register --force
+```
-After that, run three commands shown below.
+#### MacPorts
+If you are using macports, run the following commands.
- brew install libtool autoconf automake autogen
- gem install cztop
- gem install iruby
+```shell
+port install libtool autoconf automake autogen
+gem install ffi-rzmq
+gem install iruby
+```
-#### FreeBSD
-
+### 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
- ```
+```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
- ```
+```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
- ```
-### Installation for jRuby
+```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
+```
-Since jRuby is fully compatible with Ruby version 2.2, it is possible to use iruby with jRuby.
-It can be helpful if you want to use java classes in your iruby notebook.
-This will require the following software:
-* jRuby version >= 9.0.4.0
+### Installation for JRuby
+
+You can use Java classes in your IRuby notebook.
+
+* JRuby version >= 9.0.4.0
* cztop gem
-* this iruby gem
+* iruby gem
-After installation, make sure that your `env` is set up to jruby.
+After installation, make sure that your `env` is set up to use jruby.
+
```shell
$ env ruby -v
```
+
If you use RVM, it is enough to switch the current version to jruby.
-If you have already used iruby with a different version, you need to generate a new kernel:
+
+If you have already used IRuby with a different version, you need to generate a new kernel:
+
```shell
$ iruby register --force
```
-After that you can use iruby with jRuby in usual way.
-### After the installation
-
+## Notebooks
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/).
+## Contributing
+We welcome contributions from everyone.
-### Required dependencies
-
-* IPython/Jupyter >= 3.0.0
-* Ruby >= 2.1.0
-
-If you install IRuby with CZTop, CZMQ >= 4.0.0 is added to the list above.
-
-If you install IRuby with ffi-rzmq, libzmq >= 3.2 is added to the list above.
-
-### Authors
-
+## Authors
See the [CONTRIBUTORS](CONTRIBUTORS) file.
-### License
+## License
+Copyright © 2013-19, IRuby contributors and the Ruby Science Foundation.
-Copyright © 2013-15, IRuby contributors and the Ruby Science Foundation.
-
All rights reserved.
-IRuby, along with [SciRuby](http://sciruby.com/), is licensed under the MIT license. See the [LICENSE](LICENSE) file for details.
+IRuby, along with [SciRuby](http://sciruby.com/), is licensed under the MIT license. See the [LICENSE](LICENSE) file.