Merge pull request #9 from ptone/dev-quickstart

Interim update for dev quickstart
11 years ago · c353c6bbe6
parent 72381a1ac3 aab26d8ebe
commit c353c6bbe6
1 changed files with 12 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -2,6 +2,18 @@

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

+Dev quickstart:
+
+* Create a virtual env (ie jupyter-dev)
+* ensure that you have node/npm installed (ie brew install node on OS X)
+* Clone this repo and cd into it
+* pip install -r requirements.txt
+* pip install -e .
+
+_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
+