Skip to content

Commit dc30adc

Browse files
authored
Update README.md (#287)
To contributors In February 2021, IRuby became the canonical repository and is no longer a fork from minrk/iruby. Please fork from this repository again before making pull requests. Thank you for contributing to IRuby.
1 parent 011c1cd commit dc30adc

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ IRuby is a Ruby kernel for [Jupyter project](http://try.jupyter.org/).
99
## Installation
1010

1111
### Requirements
12+
1213
* [Jupyter](https://jupyter.org)
1314
* One of the following is required
1415
* [ffi-rzmq](https://github.com/chuckremes/ffi-rzmq) and [libzmq](https://github.com/zeromq/libzmq)
@@ -28,6 +29,7 @@ gem specific_install https://github.com/SciRuby/iruby
2829
```
2930

3031
### Ubuntu
32+
3133
Install Jupyter with [Anaconda](https://www.anaconda.com/) (recommended).
3234

3335
#### 17.04 to 19.04
@@ -42,6 +44,7 @@ iruby register --force
4244
```
4345

4446
#### 16.04
47+
4548
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.
4649

4750
```shell
@@ -57,6 +60,7 @@ iruby register --force
5760
```
5861

5962
### Windows
63+
6064
Install git and Jupyter with [Anaconda](https://www.anaconda.com/) (recommended).
6165
[DevKit](https://rubyinstaller.org/add-ons/devkit.html) is necessary for building RubyGems with native C-based extensions.
6266

@@ -72,10 +76,12 @@ iruby register --force
7276
```
7377

7478
### macOS
79+
7580
Install ruby with rbenv or rvm.
7681
Install Jupyter with [Anaconda](https://www.anaconda.com/) (recommended).
7782

7883
#### Homebrew
84+
7985
```shell
8086
brew install automake gmp libtool wget
8187
brew install zeromq --HEAD
@@ -92,6 +98,7 @@ iruby register --force
9298
```
9399

94100
#### MacPorts
101+
95102
If you are using macports, run the following commands.
96103

97104
```shell
@@ -132,14 +139,21 @@ $ iruby register --force
132139
```
133140

134141
## Notebooks
142+
135143
Take a look at the [example notebook](http://nbviewer.ipython.org/urls/raw.github.com/SciRuby/sciruby-notebooks/master/getting_started.ipynb)
136144
and the [collection of notebooks](https://github.com/SciRuby/sciruby-notebooks/) which includes a Dockerfile to create a containerized installation of iruby
137145
and other scientific gems. You can find the prebuild image at [dockerhub](https://registry.hub.docker.com/u/minad/sciruby-notebooks/).
138146

139147
## Contributing
140-
We welcome contributions from everyone.
148+
149+
Contributions to IRuby are very welcome.
150+
151+
To former contributors
152+
153+
In February 2021, [IRuby became the canonical repository](https://github.com/SciRuby/iruby/issues/285) and is no longer a fork from [minrk/iruby](https://github.com/minrk/iruby). Please fork from this repository again before making pull requests.
141154

142155
## License
156+
143157
Copyright (c) IRuby contributors and the Ruby Science Foundation.
144158

145159
Licensed under the [MIT](LICENSE) license.

0 commit comments

Comments
 (0)