Add README

2014-06-26 17:29:02 -07:00
parent 015376bc27
commit ad70872013
1 changed files with 12 additions and 0 deletions
@@ -0,0 +1,12 @@
+A simple IPython kernel for bash
+
+This requires IPython 3, which is not yet released.
+
+To test it, install with ``setup.py``, then::
+
+    ipython qtconsole --kernel bash
+
+For details of how this works, see IPython's docs on `wrapper kernels
+<http://ipython.org/ipython-doc/dev/development/wrapperkernels.html>`_, and
+Pexpect's docs on the `replwrap module
+<http://pexpect.readthedocs.org/en/latest/api/replwrap.html>`_