Skip to content

Commit

Permalink
update jupyter docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sigmaSd committed Jul 28, 2024
1 parent 77e34a4 commit 2906405
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 1 addition & 1 deletion crates/irust/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ Since version `1.60.0` IRust supports spawning a local server, by changing `loca
This allows it to be controlled programmatically, which in turns allows writing vim plugins that uses this, see https://github.com/sigmaSd/irust-vim-plugin

## Jupyter Notebook
Currently there is a barebone kernel that is easily installable see https://github.com/sigmaSd/IRust/blob/master/crates/irust_repl/README.md#jupyter-kernel for instructions
A Jupyter Kernel is available, see https://github.com/sigmaSd/IRust/blob/master/crates/irust_repl/README.md#jupyter-kernel for instructions

## Book
`The IRust Book` is intended to document a couple of tips and tricks https://sigmasd.github.io/irust_book
Expand Down
4 changes: 3 additions & 1 deletion crates/irust_repl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Checkout the examples and tests folders for more info.


## Jupyter Kernel
A basic jupyer kernel is provided for demo https://github.com/sigmaSd/IRust/tree/master/crates/irust_repl/irust_kernel, to use it:
A Jupyter Kernel is provided https://github.com/sigmaSd/IRust/tree/master/crates/irust_repl/irust_kernel, to use it:

Installation
------------
Expand All @@ -29,6 +29,8 @@ This requires IPython 3.

To use it, run one of:

code # vscode have the best implementation
zed # zed implementation is nice as well
jupyter notebook
# In the notebook interface, select IRust from the 'New' menu
jupyter qtconsole --kernel irust
Expand Down

0 comments on commit 2906405

Please sign in to comment.