Merge pull request #394 from martin-schulze-vireso/bugfix/broken_link…

…s_in_documentation

Fix broken links in documentation

docs/source/index.rst

@@ -12,11 +12,3 @@ Versions before v1.2.1 are documented over `there <https://github.com/bats-core/
    docker-usage
    writing-tests
 
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/source/installation.rst

@@ -0,0 +1,152 @@
+
+Installation
+============
+
+Supported Bash versions
+^^^^^^^^^^^^^^^^^^^^^^^
+
+The following is a list of Bash versions that are currently supported by Bats.
+This list is composed of platforms that Bats has been tested on and is known to
+work on without issues.
+
+
+* 
+  Bash versions:
+
+
+  * Everything from ``3.2.57(1)`` and higher (macOS's highest version)
+
+* 
+  Operating systems:
+
+
+  * Arch Linux
+  * Alpine Linux
+  * Ubuntu Linux
+  * FreeBSD ``10.x`` and ``11.x``
+  * macOS
+  * Windows 10
+
+* 
+  Latest version for the following Windows platforms:
+
+
+  * Git for Windows Bash (MSYS2 based)
+  * Windows Subsystem for Linux
+  * MSYS2
+  * Cygwin
+
+Homebrew
+^^^^^^^^
+
+On macOS, you can install `Homebrew <https://brew.sh/>`_ if you haven't already,
+then run:
+
+.. code-block:: bash
+
+   $ brew install bats-core
+
+npm
+^^^
+
+You can install the `Bats npm package <https://www.npmjs.com/package/bats>`_ via:
+
+.. code-block::
+
+   # To install globally:
+   $ npm install -g bats
+
+   # To install into your project and save it as one of the "devDependencies" in
+   # your package.json:
+   $ npm install --save-dev bats
+
+Installing Bats from source
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Check out a copy of the Bats repository. Then, either add the Bats ``bin``
+directory to your ``$PATH``\ , or run the provided ``install.sh`` command with the
+location to the prefix in which you want to install Bats. For example, to
+install Bats into ``/usr/local``\ ,
+
+.. code-block::
+
+   $ git clone https://github.com/bats-core/bats-core.git
+   $ cd bats-core
+   $ ./install.sh /usr/local
+
+
+**Note:** You may need to run ``install.sh`` with ``sudo`` if you do not have
+permission to write to the installation prefix.
+
+Installing Bats from source onto Windows Git Bash
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Check out a copy of the Bats repository and install it to ``$HOME``. This
+will place the ``bats`` executable in ``$HOME/bin``\ , which should already be
+in ``$PATH``.
+
+.. code-block::
+
+   $ git clone https://github.com/bats-core/bats-core.git
+   $ cd bats-core
+   $ ./install.sh $HOME
+
+
+Running Bats in Docker
+^^^^^^^^^^^^^^^^^^^^^^
+
+There is an official image on the Docker Hub:
+
+.. code-block::
+
+   $ docker run -it bats/bats:latest --version
+
+
+Building a Docker image
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Check out a copy of the Bats repository, then build a container image:
+
+.. code-block::
+
+   $ git clone https://github.com/bats-core/bats-core.git
+   $ cd bats-core
+   $ docker build --tag bats/bats:latest .
+
+
+This creates a local Docker image called ``bats/bats:latest`` based on `Alpine
+Linux <https://github.com/gliderlabs/docker-alpine/blob/master/docs/usage.md>`_
+(to push to private registries, tag it with another organisation, e.g.
+``my-org/bats:latest``\ ).
+
+To run Bats' internal test suite (which is in the container image at
+``/opt/bats/test``\ ):
+
+.. code-block::
+
+   $ docker run -it bats/bats:latest /opt/bats/test
+
+
+To run a test suite from a directory called ``test`` in the current directory of
+your local machine, mount in a volume and direct Bats to its path inside the
+container:
+
+.. code-block::
+
+   $ docker run -it -v "${PWD}:/code" bats/bats:latest test
+
+
+..
+
+   ``/code`` is the working directory of the Docker image. "${PWD}/test" is the
+   location of the test directory on the local machine.
+
+
+This is a minimal Docker image. If more tools are required this can be used as a
+base image in a Dockerfile using ``FROM <Docker image>``.  In the future there may
+be images based on Debian, and/or with more tools installed (\ ``curl`` and ``openssl``\ ,
+for example). If you require a specific configuration please search and +1 an
+issue or `raise a new issue <https://github.com/bats-core/bats-core/issues>`_.
+
+Further usage examples are in
+`the wiki <https://github.com/bats-core/bats-core/wiki/Docker-Usage-Examples>`_.

docs/source/writing-tests.md

@@ -8,7 +8,7 @@ process.
 For more details about how Bats evaluates test files, see [Bats Evaluation
 Process][bats-eval] on the wiki.
 
-For sample test files, see [examples](/docs/examples).
+For sample test files, see [examples](https://github.com/bats-core/bats-core/tree/master/docs/examples).
 
 [bats-eval]: https://github.com/bats-core/bats-core/wiki/Bats-Evaluation-Process