Skip to content

Update README #254

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Oct 10, 2019
Merged

Update README #254

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d3ceb13
Update README
kojix2 Oct 10, 2019
d773478
Add Requirements to README
kojix2 Oct 10, 2019
35dd887
Update README
kojix2 Oct 10, 2019
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
31 changes: 16 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,39 +7,40 @@
IRuby is a Ruby kernel for [Jupyter project](http://try.jupyter.org/).

## Installation
How to set up [ZeroMQ](http://zeromq.org/) depends on your environment.
You can use one of the following libraries.
* [ffi-rzmq](https://github.com/chuckremes/ffi-rzmq) and [libzmq](https://github.com/zeromq/libzmq) >= 3.2
* [CZTop](https://gitlab.com/paddor/cztop) and [CZMQ](https://github.com/zeromq/czmq) >= 4.0.0

### Requirements
* [Jupyter](https://jupyter.org)
* One of the following is required
* [ffi-rzmq](https://github.com/chuckremes/ffi-rzmq) and [libzmq](https://github.com/zeromq/libzmq)
* [CZTop](https://gitlab.com/paddor/cztop) and [CZMQ](https://github.com/zeromq/czmq)

We recommend the [Pry](https://github.com/pry/pry) backend for full functionality.

### Ubuntu
Install Jupyter with [Anaconda](https://www.anaconda.com/) (recommended).

#### 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.
#### 17.04 to 19.04

```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
sudo apt install libzmq3-dev libczmq-dev

gem install cztop
gem install ffi-rzmq
gem install iruby --pre
iruby register --force
```

#### Setup ZeroMQ on Ubuntu 17.04 to 18.10
Use official packages.
#### 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.

```shell
sudo apt install libtool libffi-dev ruby ruby-dev make
sudo apt install libzmq3-dev libczmq-dev
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 ffi-rzmq
gem install cztop
gem install iruby --pre
iruby register --force
```
Expand Down