diff --git a/docs/source/install.rst b/docs/source/install.rst index a01acc15..69647129 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -3,16 +3,22 @@ Installing ``repo2docker`` ========================== -1. Install `Docker `_ as it is required to build Docker images. +Prerequisite: docker +-------------------- -2. We recommend installing ``repo2docker`` with the ``pip`` tool:: +Install `Docker `_ 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