Skip to content

Commit 941e474

Browse files
authored
Update README.md
1 parent a07913a commit 941e474

File tree

1 file changed

+25
-22
lines changed

1 file changed

+25
-22
lines changed

README.md

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,14 @@ This project came out of the [Gopher Gala](http://gophergala.com/) 2016. It is
4747

4848
### Local, Linux
4949

50-
Dependencies:
50+
Make sure you have the following dependencies:
5151

5252
- [Go](https://golang.org/) (Tested with Go 1.5 and 1.6)
5353
- Jupyter (see [here](http://jupyter.readthedocs.org/en/latest/install.html) for more details on installing jupyter)
5454
- [ZeroMQ](http://zeromq.org/) (2.2.X or 4.x)
5555

56+
Then:
57+
5658
1. Create a workspace and setup your `GOPATH`, see https://golang.org/doc/code.html#GOPATH
5759

5860
2. Install `goimports` if you haven't already:
@@ -100,33 +102,34 @@ Dependencies:
100102
101103
### Local, OSX
102104
103-
- Assuming you're running with `homebrew`, install go:
105+
Make sure you have the following dependencies:
104106
105-
```
106-
brew install go
107-
mkdir ~/go
108-
export GOPATH=$HOME/go
109-
export PATH=$PATH:/usr/local/opt/go/libexec/bin:$GOPATH/bin
110-
```
107+
- [Go](https://golang.org/) (Tested with Go 1.5 and 1.6)
108+
- Jupyter (see [here](http://jupyter.readthedocs.org/en/latest/install.html) for more details on installing jupyter)
109+
- [ZeroMQ](http://zeromq.org/) (2.2.X or 4.x)
111110
112-
- You'll probably want to add the above exports to your `.bashrc` or equivalent.
111+
Then:
113112
114-
- Install ZeroMQ:
113+
1. Install goimports, if not already installed:
115114
116115
```
117-
brew tap homebrew/versions
118-
brew install zeromq22
119-
brew link --force zeromq22
116+
go get golang.org/x/tools/cmd/goimports
120117
```
121118
122-
- Install gophernotes:
119+
2. Install gophernotes:
120+
- with ZeroMQ 2.2.x:
123121
124-
```
125-
go get golang.org/x/tools/cmd/goimports
126-
go get github.com/gopherds/gophernotes
127-
```
122+
```
123+
go get github.com/gopherds/gophernotes
124+
```
125+
126+
- with ZeroMQ 4.x:
127+
128+
```
129+
go get -tags zmq_4_x github.com/gopherds/gophernotes
130+
```
128131
129-
if you get this error:
132+
- if you get this error:
130133
131134
```
132135
# pkg-config --cflags libzmq libzmq libzmq libzmq
@@ -143,21 +146,21 @@ Dependencies:
143146

144147
```
145148
146-
- Copy the kernel config:
149+
3. Copy the kernel config:
147150
148151
```
149152
mkdir -p ~/.local/share/jupyter/kernels/gophernotes
150153
cp -r $GOPATH/src/github.com/gopherds/gophernotes/kernel/* ~/.local/share/jupyter/kernels/gophernotes
151154
```
152155
153-
Note, depending on which version of jupyter you are using and if you are using Anaconda, you may need to copy to `~/.ipython` rather than `~/.local/share`:
156+
OR, depending on which version of jupyter you are using and if you are using Anaconda, you may need to copy to `~/.ipython` rather than `~/.local/share`:
154157
155158
```
156159
mkdir ~/.ipython/kernels/gophernotes
157160
cp -r $GOPATH/src/github.com/gopherds/gophernotes/kernel/* ~/.ipython/kernels/gophernotes/
158161
```
159162
160-
- Update `~/.local/share/jupyter/kernels/gophernotes/kernel.json` with the path to your $GOPATH installation. If you used the path above, your file will look like:
163+
4. Update `~/.local/share/jupyter/kernels/gophernotes/kernel.json` with the FULL PATH to your gophernotes binary (in $GOPATH/bin). For example:
161164
162165
```
163166
{

0 commit comments

Comments
 (0)