Merge branch 'requirements' into 'master'

Refine system requirements

See merge request openlp/documentation!25

manual/source/faq.rst

@@ -27,7 +27,7 @@ What operating systems does OpenLP support?
 -------------------------------------------
 
 OpenLP is designed to be cross platform. Currently it has been known to run on Windows (Vista, 7, 8, 10), Linux (Ubuntu
-and its variants, Fedora, Debian, ArchLinux, Mint, OpenSUSE and many others), FreeBSD and macOS. `Please let us know`_
+and its variants, Fedora, Debian, ArchLinux, Mint, OpenSUSE and many others), and macOS. `Please let us know`_
 if you have successfully run it on something else.
 
 Which programming language is OpenLP developed in?
@@ -204,8 +204,8 @@ Location of OpenLP files
 Where do I find the configuration file?
 ---------------------------------------
 
-Linux, FreeBSD and PC-BSD
-^^^^^^^^^^^^^^^^^^^^^^^^^
+Linux and Unix-like systems
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 If your distribution supports the XDG standard, you will find OpenLP's configuration file in::
 
@@ -242,8 +242,8 @@ Normally you can open the data folder by using the menu :menuselection:`Tools --
 window will appear with the data folder. In some cases due to bugs or other issues this is not an option, and the
 folder must be found manually.
 
-Linux, FreeBSD and PC-BSD
-^^^^^^^^^^^^^^^^^^^^^^^^^
+Linux and Unix-like systems
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The data folder is located in ``/home/<user>/.local/share/openlp``.
 

manual/source/glossary.rst

@@ -61,7 +61,7 @@ Platform
 --------
 
 When the word "platform" is used, it is usually referring to your operating
-system, Windows, Linux, (Mac) OS X or FreeBSD/PC-BSD.
+system, such as Windows, Linux, or macOS, in combination with the CPU family.
 
 .. _g-preview-pane:
 

manual/source/index.rst

@@ -26,7 +26,6 @@ Getting Started With OpenLP
    install_windows
    install_mac
    install_linux
-   install_bsd
 
 Reference Manual
 ----------------

manual/source/install_bsd.rst

@@ -1,31 +0,0 @@
-Installing OpenLP on BSD
-========================
-
-PC-BSD
-^^^^^^
-
-You will need to have root privileges to install OpenLP. You will be asked for 
-the root password several times during installation.
-
-From the KickOff Menu select :guilabel:`System Settings`. From the System
-Settings select :guilabel:`Software & Updates`
-
-.. image:: pics/1pcbsd.png
-
-When prompted click on the :guilabel:`Run in Administrator Mode` button and
-enter your root password when asked.
-
-.. image:: pics/2pcbsd.png
-
-Type *openlp* into the search box then click :guilabel:`Search`. When OpenLP is
-located click on :guilabel:`Download`
-
-.. image:: pics/3pcbsd.png
-
-Confirm you want to download OpenLP. You should now be able to see the progress
-of the OpenLP download and installation.
-
-.. image:: pics/4pcbsd.png
-
-When the installation has completed OpenLP will be available from the KickOff menu.
-

manual/source/install_linux.rst

@@ -13,13 +13,14 @@ Installation of OpenLP on Ubuntu can either be done through the Software Center
 or the command line. Command line instructions will be included at the end of
 this section on Ubuntu and its variants.
 
-OpenLP 3.0 supports Ubuntu 18.04 or later versions. There is currently an older
+OpenLP 3.0 supports Ubuntu 20.04 or later versions that are still supported by
+Canonical. There is currently an older
 version of OpenLP available in the official Ubuntu repositories, which can be
 found using the Software Center, but to get OpenLP 3.0 it is necessary to add
 the OpenLP Personal Package Archive (PPA) to your system. 
 
-Ubuntu, Ubuntu GNOME, Xubuntu
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Ubuntu, Xubuntu
+^^^^^^^^^^^^^^^
 
 Open up the software center using :menuselection:`Applications`
 and select the Software Center from the bottom of the menu. You will need to 

manual/source/install_mac.rst

@@ -11,10 +11,10 @@ progress.
 
 .. image:: pics/install-macos-02-install-progress.png
 
-Since OpenLP is an Open Source project we do not have the finacial means to buy an official Apple Developer certificate,
+Since OpenLP is an Open Source project we do not have the financial means to buy an official Apple Developer certificate,
 which means that macOS will refuse to open OpenLP because it has not been signed by an official Apple Developer
 certificate. We do assure you that if you downloaded OpenLP from the `OpenLP website`_, it is safe to install and run.
-To start OpenLP open the :guilabel:`Applications` folder, find the OpenLP icon an click it. The first time you start
+To start OpenLP open the :guilabel:`Applications` folder, find the OpenLP icon and click it. The first time you start
 OpenLP a window will open showing the verification progress.
 
 .. image:: pics/install-macos-03-verifying.png

manual/source/system_requirements.rst

@@ -2,20 +2,28 @@
 Minimum System Requirements
 ===========================
 
-OpenLP should run well on any fairly recent machine. The following are suggested
+OpenLP should run well on any fairly recent machine that can run a Chromium
+browser. If you do not find specific installation instructions for your system,
+you might still be able to run OpenLP but issues caused by your platform will
+not be addressed. The most constraining OpenLP dependency is PyQt5-WebEngine.
+If it is available for your system, chances are that you can run OpenLP from
+`PyPI`_.
+
+The following are suggested
 specifications to get reasonable performance. It may be possible to run OpenLP
 on less powerful hardware but you may not get the performance you desire.
 
 * 2Ghz CPU
-* 1GB RAM
+* 2GiB RAM
 * 100MB free disk space
-* Windows Vista/7/8/10, Linux, macOS (10.8 or later), FreeBSD
+* Windows 10/11, Linux, macOS (10.8 or later)
 * Multiple Monitor Support is highly recommended (not required)
 * For Presentation support:
 
-  * Windows: PowerPoint XP or later, PowerPoint Viewer 2003 or 2007 (not 2010)
-    or LibreOffice Impress 4 or later (32 bit)
+  * Windows: PowerPoint XP or later or LibreOffice Impress 4 or later
   * Linux: LibreOffice Impress 4 or later
   * macOS: Not supported yet due to limitations in Keynote and PowerPoint
 * The Generic Document/Presentation and Songs of Fellowship song import options
   require LibreOffice 4 or later
+
+:: _PyPI: https://pypi.org/project/OpenLP/

manual/source/troubleshooting.rst

@@ -90,8 +90,8 @@ and then close down OpenLP.
 In the Explorer window you left open, you will see the ``openlp.log`` file. This 
 is the file to e-mail.
 
-Linux/FreeBSD
-^^^^^^^^^^^^^
+Linux and Unix-like systems
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 If you installed OpenLP from a package::