From 7eb6cb12d5e7966a27ee119417290bf8cfef64fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien=20Geron?= Date: Thu, 18 Feb 2016 00:30:04 +0100 Subject: [PATCH] Added installation instructions --- README.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ed3391c..ac1f644 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,36 @@ python. Simply open the [Jupyter](http://jupyter.org/) notebooks you are interested in: -* within github (start at [index.ipynb](https://github.com/ageron/ml-notebooks/blob/master/index.ipynb)) * using [Binder](http://mybinder.org/): [![Binder](http://mybinder.org/badge.svg)](http://mybinder.org/repo/ageron/ml-notebooks) + * this let's you experiment with the code examples +* or directly within github (start at [index.ipynb](https://github.com/ageron/ml-notebooks/blob/master/index.ipynb)) * or by cloning this repository and running Jupyter locally. + * if you prefer this option, follow the installation instructions below. + +# Installation + +You will need [git](https://git-scm.com/), obviously. + +First, clone this repository: + + $ cd {*your development directory*} + $ git clone https://github.com/ageron/ml-notebooks.git + $ cd ml-notebooks + +If you want an isolated environment, you can use [virtualenv](https://virtualenv.readthedocs.org/en/latest/): + + $ virtualenv env + $ source ./env/bin/activate + +Next, install the required python packages using pip: + + $ pip install -r requirements.txt # On Linux + OR + $ pip install -r requirements_macosx.txt # On MacOSX + +Finally, launch Jupyter: + + $ jupyter notebook + +This should start the Jupyter server locally, and open a browser window. Click on `index.ipynb` to get started.