Mercurial > hg > Members > aka > jupyter_CbC_kernel

comparison README.md @ 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 778218c42d18
children 69fc0b9c02b8
comparison
equal deleted inserted replaced
45:e9b123952dff 46:59cf2351e933
29 29
30 ![Example of notebook](example-notebook.png?raw=true "Example of notebook") 30 ![Example of notebook](example-notebook.png?raw=true "Example of notebook")
31 31
32 ## Contributing 32 ## Contributing
33 33
34 The docker image installs the kernel in editable mode, meaning that you can
35 change the code in real-time in Docker. For that, just run the docker box like
36 that:
37
38 ```bash
39 git clone https://github.com/brendan-rius/jupyter-c-kernel.git
40 cd jupyter-c-kernel
41 docker run -v $(pwd):/jupter/jupyter_c_kernel/ -p 8888:8888 brendanrius/jupyter-c-kernel
42 ```
43
44 This clones the source, run the kernel, and binds the current folder (the one
45 you just cloned) to eh corresponding folder in Docker.
46 Now, if you change the source, it will be reflected in [http://localhost:8888](http://localhost:8888)
47 instantly. Do not forget to click "restart" the kernel on the page as it does
48 not auto-restart.
49
50 ### Version control
51
34 Create branches named `issue-X` where `X` is the number of the issue. 52 Create branches named `issue-X` where `X` is the number of the issue.
35 Rebase instead of merge. 53 Rebase instead of merge.
36 54
37 ## License 55 ## License
38 56