[doc] update and restructure installation documentation

gnif · Mar 8, 2024 · 4a4f72b · 4a4f72b
1 parent eb31815
commit 4a4f72b
Show file tree

Hide file tree

Showing 9 changed files with 657 additions and 404 deletions.
diff --git a/doc/build.rst b/doc/build.rst
@@ -132,6 +132,15 @@ Fetching with APT
 
 You can fetch these dependencies with the following command:
 
+.. warning::
+
+   Do not just blindly install the list below, check if you are using PipeWire
+   or PulseAudio and adjust the list accordingly. Installing PipeWire libraries
+   on a PulseAudio system will result in a broken partial PipeWire install.
+
+   If you are not already using PipeWire we highly recommend you upgrade,
+   Looking Glass does not support audio input (microphone) with PulseAudio.
+
 .. code:: bash
 
    apt-get install binutils-dev cmake fonts-dejavu-core libfontconfig-dev \

diff --git a/doc/conf.py b/doc/conf.py
@@ -22,7 +22,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Looking Glass'
-copyright = '2022, Looking Glass team'
+copyright = '2024, Looking Glass team'
 author = 'Geoffrey McRae and the Looking Glass team'
 
 rst_prolog = """

diff --git a/doc/index.rst b/doc/index.rst
@@ -11,9 +11,9 @@ systems for legacy programs that require high-performance graphics.
    :maxdepth: 2
 
    requirements
+   build
    install
    usage
-   build
    troubleshooting
    obs
    module
-Original file line number
+Diff line change
@@ Expand Up @@
        :maxdepth: 2
        requirements
+       build
        install
        usage
-       build
        troubleshooting
        obs
        module
@@ Expand Down @@