Merge pull request #2325 from AyanSinhaMahapatra/docs-update

Update Installation Docs

Author: pombredanne

INSTALL.rst

@@ -2,9 +2,10 @@
 Installation
 ============
 
-There are 3 main ways you can `install ScanCode <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html>`_.
+There are 4 main ways you can `install ScanCode <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html>`_.
 
 - Installation as an Application: Downloading Releases (Recommended)
+- Docker Installation
 - Installation as a library: via pip
 - Installation from Source Code: Git Clone
 
@@ -32,14 +33,30 @@ Installation as an Application : Downloading Releases
     - Linux/Mac : ``./scancode --help``
     - Windows : ``scancode --help``
 
+Docker Installation
+-------------------
+
+#. Download the Source Code as an archive from the `GitHub releases <https://github.com/nexB/scancode-toolkit/releases>`_ and unzip it, or via `git clone`.
+
+#. Build the docker image from the `scancode-toolkit` directory.::
+
+	docker build -t scancode-toolkit .
+
+#. Mount current working directory and run scan on mounted folder::
+
+    docker run -v $PWD/:/project scancode-toolkit -clpeui --json-pp /project/result.json /project
+
+Note that the parameters *before* ``scancode-toolkit`` are used for docker,
+those after will be forwarded to scancode.
+
 Installation as a library: via pip
 ----------------------------------
 
 #. Create a Python 3.6 Virtual Environment and activate the same::
 
     virtualenv -p /usr/bin/python3.6 venv-scancode && source venv-scancode/bin/activate
 
-#. Run ``pip install scancode-toolkit`` 
+#. Run ``pip install scancode-toolkit[full]``
 
 Installation from Source Code: Git Clone
 ----------------------------------------

docs/source/contribute/cut_new_release.rst

@@ -42,4 +42,4 @@ How to cut a new release:
     - Run twine with ``twine upload dist/<path to the built wheel>``
     - Once uploaded check the published release at https://pypi.python.org/pypi/scancode-toolkit/
     - Then create a new fresh local virtualenv and test the wheel installation with:
-      ``pip install scancode-toolkit``
+      ``pip install scancode-toolkit[full]``

docs/source/getting-started/install.rst

@@ -246,6 +246,7 @@ Installation via Docker:
 ------------------------
 
 You can install Scancode Toolkit by building a Docker image from the included Dockerfile.
+The prerequisite is a working `docker installation <https://docs.docker.com/engine/install/>`_.
 
 Download the ScanCode-Toolkit Source Code
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -258,7 +259,7 @@ Build the Docker image
 ^^^^^^^^^^^^^^^^^^^^^^
 
 The ``docker build`` command needs to run in the directory of the source code,
-make sure to ``cd`` into the correct directory.
+make sure to ``cd`` into the correct directory.::
 
     cd scancode-toolkit
     docker build -t scancode-toolkit .
@@ -268,17 +269,17 @@ Run using Docker
 
 The docker image will forward all arguments it receives directly to the ``scancode`` command.
 
-Display help:
+Display help::
 
     docker run scancode-toolkit --help
 
-Mount current working directory and run scan on mounted folder:
+Mount current working directory and run scan on mounted folder::
 
     docker run -v $PWD/:/project scancode-toolkit -clpeui --json-pp /project/result.json /project
 
 This will mount your current working from the host into ``/project`` in the container
 and then scan the contents. The output ``result.json`` will be written back to your
-corrent working directory on the host.
+current working directory on the host.
 
 Note that the parameters *before* ``scancode-toolkit`` are used for docker,
 those after will be forwarded to scancode.
@@ -361,7 +362,7 @@ For more information on Python virtualenv, visit this `page <https://docs.python
 
     source venv-scancode/bin/activate
 
-#. Run ``pip install scancode-toolkit`` to install the latest version of Scancode.
+#. Run ``pip install scancode-toolkit[full]`` to install the latest version of Scancode.
 
 .. NOTE::
 

docs/source/getting-started/newcomer.rst

@@ -82,12 +82,13 @@ Before you start using Scancode
    is created.
 
 :ref:`app_install`
+:ref:`docker_install`
 :ref:`pip_install`
 :ref:`source_code_install`
 
 
 #. Now you can either follow the instructions for the recommended :ref:`app_install` method ,
-   or run ``pip install scancode-toolkit`` like that in the :ref:`pip_install` documentation.
+   or run ``pip install scancode-toolkit[full]`` like that in the :ref:`pip_install` documentation.
    Alternatively, you can also :ref:`source_code_install`.
 
 #. Run ``scancode -h`` to make sure Scancode was installed properly.

docs/source/tutorials/how_to_run_a_scan.rst

@@ -36,7 +36,7 @@ Setting up Scancode Toolkit
 
 Get ScanCode Toolkit from ``pip``::
 
-    pip install scancode-toolkit
+    pip install scancode-toolkit[full]
 
 .. Note::