mirrors/jupyter-c-kernel
1
0
Fork 0
mirror of https://github.com/XaverKlemenschits/jupyter-c-kernel.git synced 2025-04-16 11:26:10 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add instruction on how to live-edit the code

Browse Source
This commit is contained in:
Brendan Rius 2016-06-08 11:29:29 +01:00
parent 6a26d60a2b
commit f60d66cf75
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -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.