add a bit of clarity to install instructions

pull/262/head
Carol Willing 2018-03-15 08:39:23 -07:00
rodzic 0506c3fe29
commit 9aeb48abf7
1 zmienionych plików z 21 dodań i 4 usunięć

Wyświetl plik

@ -3,16 +3,22 @@
Installing ``repo2docker``
==========================
1. Install `Docker <https://www.docker.com>`_ as it is required to build Docker images.
Prerequisite: docker
--------------------
2. We recommend installing ``repo2docker`` with the ``pip`` tool::
Install `Docker <https://www.docker.com>`_ as it is required to build Docker images.
Installing with ``pip``
-----------------------
We recommend installing ``repo2docker`` with the ``pip`` tool::
python3 -m pip install jupyter-repo2docker
For infomation on using ``repo2docker``, see :ref:`usage`.
Installing repo2docker from source code
---------------------------------------
Installing from source code
---------------------------
Alternatively, you can install repo2docker from source,
i.e. if you are contributing back to this project::
@ -23,3 +29,14 @@ i.e. if you are contributing back to this project::
That's it! For information on using ``repo2docker``, see
:ref:`usage`.
Note about Windows support
--------------------------
Windows support by ``repo2docker`` is still in the experimental stage.
An article about `using Windows and the WSL`_ (Windows Subsytem for Linux or
Bash on Windows) provides additional information about Windows and docker.
.. _using Windows and the WSL: https://nickjanetakis.com/blog/setting-up-docker-for-windows-and-wsl-to-work-flawlessly