From b74ff05910d9ebf72d75278f1253c89c874d325e Mon Sep 17 00:00:00 2001 From: Jon Mease <jon.mease@gmail.com> Date: Wed, 25 Jul 2018 12:37:27 -0400 Subject: [PATCH] Add installation instructions to the README --- README.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aa3b21d..3c13803 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,34 @@ # plotly_ipywidget_notebooks -Example notebooks using the ipywidgets integration in plotly.py 3.0 +Example notebooks using the ipywidgets integration in plotly.py version 3 + +## Getting started +First, clone this repository and cd into the project directory + +``` +$ git clone https://github.com/jonmmease/plotly_ipywidget_notebooks.git +$ cd plotly_ipywidget_notebooks +``` + +Then install the package requirements + +``` +$ pip install -r requirements.txt +``` + +If you want to use the classic Jupyter Notebook, launch it + +``` +$ jupyter notebook +``` + +If you want to use JupyterLab, follow the instructions in the +[plotly.py README](https://github.com/plotly/plotly.py) to install the +`jupyterlab` python package along with the required JupyterLab JavaScript packages. +Pay close attension to all of the version numbers! + +## Try out using Binder +Or, just click the button below to try out these notebooks in the classic +Jupyter Notebook using binder. [](https://mybinder.org/v2/gh/jonmmease/plotly_ipywidget_notebooks/master) -- GitLab