diff --git a/README.md b/README.md index d33fadd..fbe8abe 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Build Status](https://github.com/SciRuby/iruby/workflows/CI/badge.svg)](https://github.com/SciRuby/iruby/actions) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/RubyData/binder/master?filepath=ruby-data.ipynb) -IRuby is a Ruby kernel for [Jupyter project](http://try.jupyter.org/). +IRuby is a Ruby kernel for [Jupyter project](https://jupyter.org/). ## Try IRuby @@ -20,23 +20,23 @@ The following URL launches JupyterLab directly on Binder. ### Requirements -* [Jupyter](https://jupyter.org) +- [Jupyter](https://jupyter.org) The following requirements are automatically installed. -* [ffi-rzmq](https://github.com/chuckremes/ffi-rzmq) -* [libzmq](https://github.com/zeromq/libzmq) +- [ffi-rzmq](https://github.com/chuckremes/ffi-rzmq) +- [libzmq](https://github.com/zeromq/libzmq) The following dependencies are optional. -* [Pry][Pry], if you want to use [Pry][Pry] instead of IRB for the code execution backend +- [Pry][Pry], if you want to use [Pry][Pry] instead of IRB for the code execution backend ### Installing Jupyter Notebook and/or JupyterLab See the official document to know how to install Jupyter Notebook and/or JupyterLab. -* -* +- +- ### Ubuntu @@ -108,8 +108,8 @@ docker run --rm -it -p 8888:8888 rubydata/datascience-notebook You can use Java classes in your IRuby notebook. -* JRuby version >= 9.0.4.0 -* iruby gem +- JRuby version >= 9.0.4.0 +- iruby gem After installation, make sure that your `env` is set up to use jruby. @@ -152,8 +152,8 @@ export IRUBY_SESSION_ADAPTER="cztop" There are two backends: PlainBackend and PryBackend. -* PlainBackend is the default backend. It uses [IRB](https://github.com/ruby/irb). -* PryBackend uses [Pry][Pry]. +- PlainBackend is the default backend. It uses [IRB](https://github.com/ruby/irb). +- PryBackend uses [Pry][Pry]. You can switch the backend to PryBackend by running the code below. @@ -163,9 +163,9 @@ IRuby::Kernel.instance.switch_backend!(:pry) ## Notebooks -Take a look at the [example notebook](http://nbviewer.ipython.org/urls/raw.github.com/SciRuby/sciruby-notebooks/master/getting_started.ipynb) +Take a look at the [example notebook](https://nbviewer.jupyter.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/). +and other scientific gems. ## Contributing