Skip to content

Commit 8b90001

Browse files
authored
Merge pull request #9 from slel/patch-1
Update README, pointing to gophernotes
2 parents f42d84c + e54e759 commit 8b90001

File tree

1 file changed

+28
-15
lines changed

1 file changed

+28
-15
lines changed

README.rst

+28-15
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,39 @@
1-
A Go kernel for IPython
2-
=======================
1+
A toy Go kernel for Jupyter
2+
===========================
33

4-
To install::
4+
Warning
5+
-------
56

6-
pip install ipython[notebook]
7+
This project was a 2013 proof-of-concept Go kernel for Jupyter in which Go code
8+
was run using `go-eval <https://github.com/sbinet/go-eval/>`_.
9+
The state of the Go eval tools was too limited for this kernel to be useful.
10+
This project is no longer supported.
711

8-
go get github.com/takluyver/igo
12+
See also
13+
--------
914

10-
mkdir -p ~/.ipython/kernels/igo
11-
cp -r $GOPATH/src/github.com/takluyver/igo/kernel/* ~/.ipython/kernels/igo
15+
This project served as inspiration for a full-fledged Go kernel for Jupyter born in 2016
16+
and called `gophernotes <https://github.com/gopherdata/gophernotes>`_.
1217

13-
Edit ~/.ipython/kernels/igo/kernel.json and replace $GOPATH with your actual GOPATH
18+
See that project if you are looking for a usable, actively developed Go kernel for Jupyter.
1419

15-
To run::
20+
Installation
21+
------------
1622

17-
ipython notebook
23+
To install::
1824

19-
Go code is run using `go-eval <https://github.com/sbinet/go-eval/>`_.
25+
pip install jupyter
2026

21-
Support
27+
go get github.com/takluyver/igo
28+
29+
mkdir -p ~/.jupyter/kernels/igo
30+
cp -r $GOPATH/src/github.com/takluyver/igo/kernel/* ~/.jupyter/kernels/igo
31+
32+
Edit ``~/.jupyter/kernels/igo/kernel.json`` and replace ``$GOPATH`` with your actual ``GOPATH``.
33+
34+
Running
2235
-------
2336

24-
The project is not being supported currently.
25-
The current state of the Go eval tools are too limited for it to be useful.
26-
If you want to push it forwards, please get in touch.
37+
To run::
38+
39+
jupyter notebook

0 commit comments

Comments
 (0)