Skip to content
This repository has been archived by the owner on Feb 10, 2019. It is now read-only.

Commit

Permalink
Updates README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
funkyfuture committed Oct 7, 2015
1 parent 3b5f748 commit 7a5214c
Showing 1 changed file with 31 additions and 7 deletions.
38 changes: 31 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,34 @@

The Jupyter HTML notebook is a web-based notebook environment for interactive computing.

Dev quickstart:
## Usage

### Local installation

Launch with:

$ jupyter notebook

### In a Docker container

If you have a [Docker daemon running](https://docs.docker.com/installation/), e.g. reachable on `localhost`, start a container with:

$ docker run -d -p "8888:8888" --name="myproject" jupyter/notebook

In your browser open the URL `http://localhost:8888/`.

The image defines a [volume](https://docs.docker.com/userguide/dockervolumes/) for notebook files at `/notebooks`.
You can override it to mount a host path, e.g. the current working directory:

$ docker run -d -p "8888:8888" -v "$(pwd):/notebooks" --name="myproject" jupyter/notebook

## Installation

For a local installation, make sure you have [pip installed](https://pip.readthedocs.org/en/stable/installing/) and run:

$ pip install notebook

### Dev quickstart

* ensure that you have node/npm installed (e.g. `brew install node` on OS X)
* Clone this repo and cd into it
Expand All @@ -15,11 +42,7 @@ Dev quickstart:
_NOTE_: For Debian/Ubuntu systems, if you're installing the system node you need
to use the 'nodejs-legacy' package and not the 'node' package.

Launch with:

jupyter notebook

Example installation (tested on Ubuntu Trusty):
### Ubuntu Trusty

```
sudo apt-get install nodejs-legacy npm python-virtualenv python-dev
Expand All @@ -31,7 +54,8 @@ pip install --pre -e .
jupyter notebook
```

For FreeBSD:
### FreeBSD

```
cd /usr/ports/www/npm
sudo make install # (Be sure to select the "NODE" option)
Expand Down

0 comments on commit 7a5214c

Please sign in to comment.