From 59235ef8634b1bdc01e115839cfcf73b76a7c932 Mon Sep 17 00:00:00 2001 From: Paul Podgorsek Date: Mon, 18 Sep 2023 10:46:25 +0200 Subject: [PATCH] Issue #454 - Add a table of contents to the README --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 8204356..1958f9c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,33 @@ # Robot Framework in Docker, with Firefox, Chrome and Microsoft Edge +## Table of contents + +* [What is it?](#what-is-it) +* [Versioning](#versioning) +* [Running the container](#running-the-container) + * [Switching browsers](#switching-browsers) + * [Changing the container's screen resolution](#changing-the-containers-screen-resolution) + * [Changing the container's tests and reports directories](#changing-the-containers-tests-and-reports-directories) + * [Parallelisation](#parallelisation) + * [Parallelisation options](#parallelisation-options) + * [Passing additional options](#passing-additional-options) + * [Testing emails](#testing-emails) + * [Dealing with Datetimes and Timezones](#dealing-with-datetimes-and-timezones) +* [Security consideration](#security-consideration) +* [Continuous integration](#continuous-integration) + * [Defining a test run ID](#defining-a-test-run-id) + * [Upload test reports to an AWS S3 bucket](#upload-test-reports-to-an-aws-s3-bucket) +* [Testing this project](#testing-this-project) +* [Troubleshooting](#troubleshooting) + * [Chromium is crashing](#chromium-is-crashing) + * [Accessing the logs](#accessing-the-logs) + * [Error: Suite contains no tests](#error-suite-contains-no-tests) + * [Database tests are failing in spite of the DatabaseLibrary being present](#database-tests-are-failing-in-spite-of-the-databaselibrary-being-present) + * [Supported devices and architectures](#supported-devices-and-architectures) +* [Please contribute!](#please-contribute) + +----- + ## What is it? This project consists of a Docker image containing a Robot Framework installation.