annotate README.md @ 10:eee0f8bf43f5

Update README to add pip
author Brendan Rius <brendan@omixy.com>
date Sat, 26 Mar 2016 14:56:17 +0000
parents 6455ec6914b3
children ed81f9f93bde
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
1 # Minimal C kernel for Jupyter
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
2
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
3 ## Requirements
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
4
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
5 * gcc
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
6 * jupyter
10
eee0f8bf43f5 Update README to add pip
Brendan Rius <brendan@omixy.com>
parents: 6
diff changeset
7 * python
eee0f8bf43f5 Update README to add pip
Brendan Rius <brendan@omixy.com>
parents: 6
diff changeset
8 * pip
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
9
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
10 ## Installation
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
11
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
12 * `git clone git@github.com:brendan-rius/jupyter-c-kernel.git`
10
eee0f8bf43f5 Update README to add pip
Brendan Rius <brendan@omixy.com>
parents: 6
diff changeset
13 * `pip install jupyter-c-kernel`
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
14 * `cd jupyter-c-kernel`
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
15 * `jupyter-kernelspec install c_kernel`
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
16
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
17 ## Usage
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
18
6
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
19 * Open the example notebook: `jupyter-notebook example-notebook.ipynb`
0
50ea00cf5896 Initial commit
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
20 * Enjoy!
6
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
21
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
22 ## Example of notebook
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
23
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
24 ![Example of notebook](example-notebook.png?raw=true "Example of notebook")
6455ec6914b3 Update readme
Brendan Rius <brendan@omixy.com>
parents: 0
diff changeset
25