view README.md @ 16:63084d5da27c

Update README.md after #2 and to move the requirements to the correct section
author Brendan Rius <brendan@omixy.com>
date Mon, 18 Apr 2016 19:52:48 -0700
parents 086c0d0da045
children 81a24c69ed60
line wrap: on
line source

# Minimal C kernel for Jupyter

## Use with Docker (recommended)

 * `docker pull brendanrius/jupyter-c-kernel`
 * `docker run -d -p 8888:8888 brendanrius/jupyter-c-kernel`
 * Go to [http://localhost:8888](http://localhost:8888) (or your VM address if you are using Docker Machine)

## Manual installation

### Requirements

 * gcc
 * jupyter
 * python
 * pip

## Installation

 * `git clone git@github.com:brendan-rius/jupyter-c-kernel.git`
 * `pip install jupyter-c-kernel`
 * `cd jupyter-c-kernel`
 * `jupyter-kernelspec install c_spec/`

## Usage

 * Open the example notebook: `jupyter-notebook example-notebook.ipynb`
 * Enjoy!

## Example of notebook

![Example of notebook](example-notebook.png?raw=true "Example of notebook")