Skip to content

Commit a359fc1

Browse files
committed
README: Change the description related to the backend
1 parent 09100a8 commit a359fc1

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ If both ffi-rzmq and cztop are installed, ffi-rzmq is used. If you prefer cztop,
3131
export IRUBY_SESSION_ADAPTER="cztop"
3232
```
3333

34-
* We recommend the [Pry](https://github.com/pry/pry) backend for full functionality.
35-
* If you want to install the latest version of IRuby from the source code, try [specific_install](https://github.com/rdp/specific_install).
34+
* [Pry][Pry], if you want to use [Pry][Pry] instead of IRB for the code execution backend
35+
* If you want to install the development version of IRuby from the source code, try [specific_install](https://github.com/rdp/specific_install).
3636

3737
```
3838
gem specific_install https://github.com/SciRuby/iruby
@@ -148,6 +148,19 @@ If you have already used IRuby with a different version, you need to generate a
148148
$ iruby register --force
149149
```
150150

151+
## Backends
152+
153+
There are two backends: PlainBackend and PryBackend.
154+
155+
* PlainBackend is the default backend. It uses [IRB](https://github.com/ruby/irb).
156+
* PryBackend uses [Pry][Pry].
157+
158+
You can switch the backend to PryBackend by running the code below.
159+
160+
```ruby
161+
IRuby::Kernel.instance.switch_backend!(:pry)
162+
```
163+
151164
## Notebooks
152165

153166
Take a look at the [example notebook](http://nbviewer.ipython.org/urls/raw.github.com/SciRuby/sciruby-notebooks/master/getting_started.ipynb)
@@ -167,3 +180,5 @@ In February 2021, [IRuby became the canonical repository](https://github.com/Sci
167180
Copyright (c) IRuby contributors and the Ruby Science Foundation.
168181

169182
Licensed under the [MIT](LICENSE) license.
183+
184+
[Pry]: https://github.com/pry/pry

0 commit comments

Comments
 (0)