From ab39a246660f986a7da91be5ca1d8f92fc0601cb Mon Sep 17 00:00:00 2001 From: Thomas Kluyver Date: Sun, 8 Mar 2015 17:07:41 -0700 Subject: [PATCH] Clarify README Issue #17 --- README.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index f3f10ad..abb2417 100644 --- a/README.rst +++ b/README.rst @@ -2,9 +2,14 @@ A simple IPython kernel for bash This requires IPython 3. -To test it, install with ``setup.py``, then:: +To use it, install with ``setup.py``, and then run one of: +.. code:: shell + + ipython notebook + # In the notebook interface, select Bash from the 'New' menu ipython qtconsole --kernel bash + ipython console --kernel bash For details of how this works, see IPython's docs on `wrapper kernels `_, and