From 7082b708aec3d581d54ef3e732da9829f51f30ca Mon Sep 17 00:00:00 2001 From: dgelessus <dgelessus@users.noreply.github.com> Date: Mon, 18 May 2020 12:35:33 +0200 Subject: [PATCH] Expand section on alternative frontends in README --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bd580b4..22b0c34 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,12 @@ If the kernel was installed using `java -jar <jarfile> install`, the kernel jar After installation, start the Jupyter Notebook web interface using `jupyter notebook`. The ProB 2 kernel can be selected when creating a new notebook. -You can also use the kernel with other frontends, such as `jupyter console` and `jupyter qtconsole`, by specifying `--kernel=prob2` on the command line. +You can also use the kernel with other frontends. You may need to manually specify the ProB 2 kernel's ID (`prob2`). For example, to run the kernel using Jupyter's [console](https://jupyter-console.readthedocs.io/) and [Qt console](https://qtconsole.readthedocs.io/) frontends: + +```sh +$ jupyter console --kernel=prob2 +$ jupyter qtconsole --kernel=prob2 +``` For information on how to use the kernel, run the built-in `:help` command, or see the included [example notebooks](./notebooks). -- GitLab