Add note about os support and update example repo
# jupyter-repo2docker
-
[![Build Status](https://travis-ci.org/jupyter/repo2docker.svg?branch=master)](https://travis-ci.org/jupyter/repo2docker)
[![Documentation Status](https://readthedocs.org/projects/repo2docker/badge/?version=latest)](http://repo2docker.readthedocs.io/en/latest/?badge=latest)
-**jupyter-repo2docker** takes as input a repository source, such as a GitHub repo. It then builds, runs, and/or pushes Docker images built from
-that source.
+**jupyter-repo2docker** takes as input a repository source, such as a GitHub
+repo. It then builds, runs, and/or pushes Docker images built from that source.
See the [repo2docker documentation](http://repo2docker.readthedocs.io)
for more information.
@@ -16,15 +15,17 @@ for more information.
is recommended.
2. Python 3.4+.
+Supported on Linux and macOS. [See documentation note about Windows support.](http://repo2docker.readthedocs.io/en/latest/install.html#note-about-windows-support)
+
## Installation
-To install from pypi, the python packaging index:
+To install from PyPI, the python packaging index, using `pip`:
```bash
pip install jupyter-repo2docker
```
-To install from source and start contributing:
+To install from source:
```bash
git clone https://github.com/jupyter/repo2docker.git
@@ -34,29 +35,29 @@ pip install -e .
## Usage
-The core feature of repo2docker is to fetch a repo (from github or locally), build a container
-image based on the specifications found in the repo & optionally launch a local Jupyter Notebook
-you can use to explore it.
+The core feature of repo2docker is to fetch a repo (from github or locally),
+build a container image based on the specifications found in the repo &
+optionally launch a local Jupyter Notebook you can use to explore it.
**Note that Docker needs to be running on your machine for this to work.**
Example:
```bash
-jupyter-repo2docker https://github.com/jakevdp/PythonDataScienceHandbook
+jupyter-repo2docker https://github.com/norvig/pytudes
```
-After building (it might take a while!), it should output in your terminal something like:
-
+After building (it might take a while!), it should output in your terminal
+something like:
-```
+```bash
Copy/paste this URL into your browser when you connect for the first time,
to login with a token:
http://0.0.0.0:36511/?token=f94f8fabb92e22f5bfab116c382b4707fc2cade56ad1ace0
```
-If you copy paste that URL into your browser you will see a Jupyter Notebook with the
-contents of the repository you had just built!
+If you copy paste that URL into your browser you will see a Jupyter Notebook
+with the contents of the repository you had just built!
For more information on how to use ``repo2docker``, see the
[usage guide](http://repo2docker.readthedocs.io/en/latest/usage.html).
@@ -64,8 +65,8 @@ For more information on how to use ``repo2docker``, see the
## Repository specifications
Repo2Docker looks for configuration files in the source repository to
-determine how the Docker image should be built.
-It is philosophically similar to [Heroku Build Packs](https://devcenter.heroku.com/articles/buildpacks).
+determine how the Docker image should be built. It is philosophically similar
+to [Heroku Build Packs](https://devcenter.heroku.com/articles/buildpacks).
For a list of the configuration files that ``repo2docker`` can use,
see the [usage guide](http://repo2docker.readthedocs.io/en/latest/usage.html).
