Add a semi-automated table of content for the Install file

qgis · Sep 24, 2020 · f48eb31 · f48eb31
1 parent b83a475
commit f48eb31
Showing 1 changed file with 85 additions and 11 deletions.
diff --git a/INSTALL.md b/INSTALL.md
@@ -1,16 +1,90 @@
-QGIS
 Building QGIS from source - step by step
 
-   1. [Introduction](#1-introduction)
-   2. [Overview](#2-overview)
-   3. [Building on GNU/Linux](#3-building-on-gnulinux)
-   4. [Building on Windows](#4-building-on-windows)
-   5. [Building on MacOS X](#5-building-on-macos-x)
-   6. [Setting up the WCS test server on GNU/Linux](#6-setting-up-the-wcs-test-server-on-gnulinux)
-   7. [Setting up a Jenkins Build Server](#7-setting-up-a-jenkins-build-server)
-   8. [Debug output and running tests](#8-debug-output-and-running-tests)
-   9. [Authors and Acknowledgments](#9-authors-and-acknowledgments)
-
+<!-- Table of contents generated from https://freelance-tech-writer.github.io/table-of-contents-generator/index.html -->
+
+* [1. Introduction](#1-introduction)
+* [2. Overview](#2-overview)
+* [3. Building on GNU/Linux](#3-building-on-gnulinux)
+   * [3.1. Building QGIS with Qt 5.x](#31-building-qgis-with-qt-5x)
+   * [3.2. Prepare apt](#32-prepare-apt)
+   * [3.3. Install build dependencies](#33-install-build-dependencies)
+   * [3.4. Setup ccache (Optional, but recommended)](#34-setup-ccache-optional-but-recommended)
+   * [3.5. Prepare your development environment](#35-prepare-your-development-environment)
+   * [3.6. Check out the QGIS Source Code](#36-check-out-the-qgis-source-code)
+   * [3.7. Starting the compile](#37-starting-the-compile)
+   * [3.8. Compiling with 3D](#38-compiling-with-3d)
+       * [3.8.1. Compiling with 3D on Debian based distributions](#381-compiling-with-3d-on-debian-based-distributions)
+   * [3.9. Building different branches](#39-building-different-branches)
+   * [3.10. Building Debian packages](#310-building-debian-packages)
+   * [3.11. On Fedora Linux](#311-on-fedora-linux)
+       * [3.11.1. Install build dependencies](#3111-install-build-dependencies)
+       * [3.11.2. Suggested system tweaks](#3112-suggested-system-tweaks)
+* [4. Building on Windows](#4-building-on-windows)
+   * [4.1. Building with Microsoft Visual Studio](#41-building-with-microsoft-visual-studio)
+       * [4.1.1. Visual Studio 2015 Community Edition](#411-visual-studio-2015-community-edition)
+       * [4.1.2. Other tools and dependencies](#412-other-tools-and-dependencies)
+       * [4.1.3. Clone the QGIS Source Code](#413-clone-the-qgis-source-code)
+       * [4.1.4. Configure and build with CMake from command line](#414-configure-and-build-with-cmake-from-command-line)
+           * [4.1.4.1 Using configonly.bat to create the MSVC solution file:](#4141-using-configonlybat-to-create-the-msvc-solution-file)
+           * [4.1.4.2 Compiling QGIS with MSVC:](#4142-compiling-qgis-with-msvc)
+       * [4.1.5 Old alternative method that might still work using cmake-gui:](#415-old-alternative-method-that-might-still-work-using-cmake-gui)
+       * [4.1.6. Packaging](#416-packaging)
+       * [4.1.7. Packaging your own build of QGIS](#417-packaging-your-own-build-of-qgis)
+       * [4.1.8. Osgeo4w packaging](#418-osgeo4w-packaging)
+   * [4.2. Building using MinGW](#42-building-using-mingw)
+       * [4.2.1. MSYS](#421-msys)
+       * [4.2.2. Qt](#422-qt)
+       * [4.2.3. Flex and Bison](#423-flex-and-bison)
+       * [4.2.4. Python](#424-python)
+           * [4.2.4.1. Download and install Python - use Windows installer](#4241-download-and-install-python---use-windows-installer)
+           * [4.2.4.2. Download SIP and PyQt5 sources](#4242-download-sip-and-pyqt5-sources)
+           * [4.2.4.3. Compile SIP](#4243-compile-sip)
+           * [4.2.4.4. Compile PyQt](#4244-compile-pyqt)
+           * [4.2.4.5. Final python notes](#4245-final-python-notes)
+       * [4.2.5. git](#425-git)
+       * [4.2.6. CMake](#426-cmake)
+       * [4.2.7. QGIS](#427-qgis)
+       * [4.2.8. Compiling](#428-compiling)
+       * [4.2.9. Configuration](#429-configuration)
+       * [4.2.10. Compilation and installation](#4210-compilation-and-installation)
+       * [4.2.11. Run qgis.exe from the directory where it's installed (CMAKE_INSTALL_PREFIX)](#4211-run-qgisexe-from-the-directory-where-its-installed-cmake_install_prefix)
+       * [4.2.12. Create the installation package: (optional)](#4212-create-the-installation-package-optional)
+   * [4.3. Creation of MSYS environment for compilation of QGIS](#43-creation-of-msys-environment-for-compilation-of-qgis)
+       * [4.3.1. Initial setup](#431-initial-setup)
+           * [4.3.1.1. MSYS](#4311-msys)
+           * [4.3.1.2. MinGW](#4312-mingw)
+           * [4.3.1.3. Flex and Bison](#4313-flex-and-bison)
+       * [4.3.2. Installing dependencies](#432-installing-dependencies)
+           * [4.3.2.1. Getting ready](#4321-getting-ready)
+           * [4.3.2.2. GRASS](#4322-grass)
+           * [4.3.2.3. GEOS](#4323-geos)
+           * [4.3.2.4. SQLITE](#4324-sqlite)
+           * [4.3.2.5. GSL](#4325-gsl)
+           * [4.3.2.6. EXPAT](#4326-expat)
+           * [4.3.2.7. POSTGRES](#4327-postgres)
+       * [4.3.3. Cleanup](#433-cleanup)
+   * [4.4. Building on Linux with mxe](#44-building-on-linux-with-mxe)
+       * [4.4.1. Building with Docker](#441-building-with-docker)
+           * [4.4.1.1. Initial setup](#4411-initial-setup)
+           * [4.4.1.2. Building the dependencies](#4412-building-the-dependencies)
+           * [4.4.1.3. Cross-Building QGIS](#4413-cross-building-qgis)
+       * [4.4.2. Testing QGIS](#442-testing-qgis)
+* [5. Building on MacOS X](#5-building-on-macos-x)
+   * [5.1. Install Developer Tools](#51-install-developer-tools)
+   * [5.2. Install CMake and other build tools](#52-install-cmake-and-other-build-tools)
+   * [5.3. Install Qt5 and QGIS-Deps](#53-install-qt5-and-qgis-deps)
+   * [5.4. QGIS source](#54-qgis-source)
+   * [5.5. Configure the build](#55-configure-the-build)
+   * [5.6. Building](#56-building)
+* [6. Setting up the WCS test server on GNU/Linux](#6-setting-up-the-wcs-test-server-on-gnulinux)
+   * [6.1. Preparation](#61-preparation)
+   * [6.2. Setup mapserver](#62-setup-mapserver)
+   * [6.3. Create a home page](#63-create-a-home-page)
+   * [6.4. Now deploy it](#64-now-deploy-it)
+   * [6.5. Debugging](#65-debugging)
+* [7. Setting up a Jenkins Build Server](#7-setting-up-a-jenkins-build-server)
+* [8. Debug output and running tests](#8-debug-output-and-running-tests)
+* [9. Authors and Acknowledgments](#9-authors-and-acknowledgments)
 # 1. Introduction
 
 This document is the original installation guide of the described software