Mercurial > hg > Members > aka > jupyter_CbC_kernel

changeset 46:59cf2351e933

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add instruction on how to live-edit the code
author Brendan Rius <brendan@omixy.com>
date Wed, 08 Jun 2016 11:29:29 +0100
parents e9b123952dff
children 69fc0b9c02b8
files README.md
diffstat 1 files changed, 18 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Wed Jun 08 11:24:21 2016 +0100
+++ b/README.md	Wed Jun 08 11:29:29 2016 +0100
@@ -31,6 +31,24 @@
 
 ## Contributing
 
+The docker image installs the kernel in editable mode, meaning that you can
+change the code in real-time in Docker. For that, just run the docker box like
+that:
+
+```bash
+git clone https://github.com/brendan-rius/jupyter-c-kernel.git
+cd jupyter-c-kernel
+docker run -v $(pwd):/jupter/jupyter_c_kernel/ -p 8888:8888 brendanrius/jupyter-c-kernel
+```
+
+This clones the source, run the kernel, and binds the current folder (the one
+you just cloned) to eh corresponding folder in Docker.
+Now, if you change the source, it will be reflected in [http://localhost:8888](http://localhost:8888)
+instantly. Do not forget to click "restart" the kernel on the page as it does
+not auto-restart.
+
+### Version control
+
 Create branches named `issue-X` where `X` is the number of the issue.
 Rebase instead of merge.