Skip to content

Commit bd0dab5

Browse files
committed
take updated README.md from gopherdata/gophernotes master branch
1 parent 568d6d7 commit bd0dab5

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
`gophernotes` is a Go kernel for [Jupyter](http://jupyter.org/) notebooks and [nteract](https://nteract.io/). It lets you use Go interactively in a browser-based notebook or desktop app. Use `gophernotes` to create and share documents that contain live Go code, equations, visualizations and explanatory text. These notebooks, with the live Go code, can then be shared with others via email, Dropbox, GitHub and the [Jupyter Notebook Viewer](http://nbviewer.jupyter.org/). Go forth and do data science, or anything else interesting, with Go notebooks!
66

7-
**Acknowledgements** - This project utilizes a Go interpreter called [gomacro](https://github.com/cosmos72/gomacro) under the hood to evaluate Go code interactively. The gophernotes logo was designed by the brilliant [Marcus Olsson](https://github.com/marcusolsson) and was inspired by Renee French's original Go Gopher design.
7+
**Acknowledgements** - This project utilizes a Go interpreter called [gomacro](https://github.com/cosmos72/gomacro) under the hood to evaluate Go code interactively. The gophernotes logo was designed by the brilliant [Marcus Olsson](https://github.com/marcusolsson) and was inspired by Renee French's original Go Gopher design.
88

99
- [Examples](#examples)
1010
- Install gophernotes:
@@ -19,9 +19,9 @@
1919

2020
## Examples
2121

22-
### Jupyter Notebook:
22+
### Jupyter Notebook:
2323

24-
![](files/jupyter.gif)
24+
![](files/jupyter.gif)
2525

2626
### nteract:
2727

@@ -46,7 +46,7 @@
4646
```sh
4747
$ go get -u github.com/gopherdata/gophernotes
4848
$ mkdir -p ~/.local/share/jupyter/kernels/gophernotes
49-
$ cp $GOPATH/src/github.com/gopherdata/gophernotes/kernel/* ~/.local/share/jupyter/kernels/gophernotes
49+
$ cp $GOPATH/src/github.com/gopherdata/gophernotes/kernel/* ~/.local/share/jupyter/kernels/gophernotes
5050
```
5151

5252
To confirm that the `gophernotes` binary is installed and in your PATH, you should see the following when running `gophernotes` directly:
@@ -57,7 +57,7 @@ $ gophernotes
5757
```
5858

5959
**Note** - if you have the `JUPYTER_PATH` environmental variable set or if you are using an older version of Jupyter, you may need to copy this kernel config to another directory. You can check which directories will be searched by executing:
60-
60+
6161
```sh
6262
$ jupyter --data-dir
6363
```
@@ -80,7 +80,7 @@ $ gophernotes
8080
```
8181

8282
**Note** - if you have the `JUPYTER_PATH` environmental variable set or if you are using an older version of Jupyter, you may need to copy this kernel config to another directory. You can check which directories will be searched by executing:
83-
83+
8484
```sh
8585
$ jupyter --data-dir
8686
```
@@ -102,12 +102,12 @@ Then:
102102
REM Download w/o building.
103103
go get -d github.com/gopherdata/gophernotes
104104
cd %GOPATH%\src\github.com\gopherdata\gophernotes\zmq-win
105-
105+
106106
REM Build x64 version.
107107
build.bat amd64
108108
move gophernotes.exe %GOPATH%\bin
109109
copy lib-amd64\libzmq.dll %GOPATH%\bin
110-
110+
111111
REM Build x86 version.
112112
build.bat 386
113113
move gophernotes.exe %GOPATH%\bin
@@ -120,9 +120,9 @@ Then:
120120
mkdir %APPDATA%\jupyter\kernels\gophernotes
121121
xcopy %GOPATH%\src\github.com\gopherdata\gophernotes\kernel %APPDATA%\jupyter\kernels\gophernotes /s
122122
```
123-
123+
124124
Note, if you have the `JUPYTER_PATH` environmental variable set or if you are using an older version of Jupyter, you may need to copy this kernel config to another directory. You can check which directories will be searched by executing:
125-
125+
126126
```
127127
jupyter --data-dir
128128
```
@@ -143,7 +143,7 @@ Then:
143143
144144
### Docker
145145
146-
You can try out or run Jupyter + gophernotes without installing anything using Docker. To run a Go notebook that only needs things from the standard library, run:
146+
You can try out or run Jupyter + gophernotes without installing anything using Docker. To run a Go notebook that only needs things from the standard library, run:
147147
148148
```
149149
$ docker run -it -p 8888:8888 gopherdata/gophernotes
@@ -159,7 +159,7 @@ In either case, running this command should output a link that you can follow to
159159
160160
```
161161
$ docker run -it -p 8888:8888 -v /path/to/local/notebooks:/path/to/notebooks/in/docker gopherdata/gophernotes
162-
```
162+
```
163163
164164
## Getting Started
165165
@@ -188,10 +188,10 @@ $ docker run -it -p 8888:8888 -v /path/to/local/notebooks:/path/to/notebooks/in/
188188
gophernotes uses [gomacro](https://github.com/cosmos72/gomacro) under the hood to evaluate Go code interactively. You can evaluate most any Go code with gomacro, but there are some limitation, which are discussed in further detail [here](https://github.com/cosmos72/gomacro#current-status). Most noteably, gophernotes does NOT support:
189189
190190
- third party packages when running natively on Mac and Windows - This is a current limitation of the Go `plugin` package.
191-
- unexported struct fields are emulated
192-
- interpreted interfaces - They can be declared, but nothing more: there is no way to implement them or call their methods
193-
Note: interfaces imported from standard library or third party packages are compiled, and fully functional.
194-
- goto is only partially implemented
191+
- some corner cases on interpreted interfaces, as interface -> interface type switch and type assertion, are not implemented yet.
192+
- conversion from typed constant to interpreted interface is not implemented. Workaround: assign the constant to a variable, then convert the variable to the interpreted interface type.
193+
- goto is only partially implemented.
194+
- out-of-order code in the same cell is supported, but not heavily tested. It has some known limitations for composite literals.
195195
196196
## Troubleshooting
197197

0 commit comments

Comments
 (0)