Fix install documentation (#242)

* update installation docs

* update installation instructions

* update jdk reccomendation

* linter

Author: mdurrani808

source/conf.py

@@ -17,7 +17,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'PhotonVision'
-copyright = '2021, PhotonVision'
+copyright = '2023, PhotonVision'
 author = 'Banks Troutman, Matt Morley'
 
 # -- General configuration ---------------------------------------------------

source/docs/getting-started/installation/sw_install/gloworm.rst

@@ -40,7 +40,7 @@ Updating PhotonVision
 ---------------------
 Download the latest stable .jar from `the releases page <https://github.com/PhotonVision/photonvision/releases>`_, go to the settings tab, and upload the .jar using the Offline Update button.
 
-.. note:: If you are updating PhotonVision on a Raspberry Pi, download the .jar file that has "raspi" in the name. Otherwise, download the .jar file without "raspi" in the name.
+.. note:: If you are updating PhotonVision on a Gloworm/Limelight, download the LinuxArm64 .jar file.
 
 As an alternative option - Export your settings, reimage your coprocessor using the instructions above, and import your settings back in.
 

source/docs/getting-started/installation/sw_install/index.rst

@@ -31,3 +31,4 @@ Other
    other-coprocessors
    advanced-cmd
    romi
+   orange-pi

source/docs/getting-started/installation/sw_install/linux-pc.rst

@@ -4,7 +4,7 @@ PhotonVision may be run on a Debian-based Linux Desktop PC for basic testing and
 
 Installing Java
 ---------------
-PhotonVision requires a JDK installed and on the system path. JDK 11 is needed (different versions will not work). You may already have this if you have installed WPILib. If not, run the following to install it:
+PhotonVision requires a JDK installed and on the system path. JDK 11 is needed (different versions will not work). If you don't have JDK 11 already, run the following to install it:
 
 .. code-block::
 
@@ -14,9 +14,13 @@ PhotonVision requires a JDK installed and on the system path. JDK 11 is needed (
 
 Downloading the Latest Stable Release of PhotonVision
 -----------------------------------------------------
-Download the latest stable .jar of PhotonVision from the `GitHub releases page <https://github.com/PhotonVision/photonvision/releases>`_.
+Go to the `GitHub releases page <https://github.com/PhotonVision/photonvision/releases>`_ and download the relevant .jar file for your coprocessor.
+
+.. note::
+    If your coprocessor has a 64 bit ARM based CPU architecture (OrangePi, Raspberry Pi, etc.), download the LinuxArm64.jar file.
+
+    If your coprocessor has an 64 bit x86 based CPU arcitecture (Mini PC, laptop, etc.), download the Linuxx64.jar file.
 
-.. note:: Be sure not to download the .jar file with "-raspi" at the end as that is specifically meant for Raspberry Pi coprocessors.
 
 .. warning:: Be careful to pick the latest stable release. "Draft" or "Pre-Release" versions are not stable and often have bugs.
 

source/docs/getting-started/installation/sw_install/mac-os.rst

@@ -13,9 +13,12 @@ PhotonVision requires a JDK installed and on the system path. JDK 11 is needed (
 
 Downloading the Latest Stable Release of PhotonVision
 -----------------------------------------------------
-Download the latest stable .jar of PhotonVision from the `GitHub releases page <https://github.com/PhotonVision/photonvision/releases>`_.
+Go to the `GitHub releases page <https://github.com/PhotonVision/photonvision/releases>`_ and download the relevant .jar file for your coprocessor.
 
-.. note:: Be sure not to download the .jar file with "-raspi" at the end as that is specifically meant for Raspberry Pi coprocessors.
+.. note::
+   If you have an M1/M2 Mac, download the macarm64.jar file.
+
+   If you have an Intel based Mac, download the macx64.jar file.
 
 .. warning:: Be careful to pick the latest stable release. "Draft" or "Pre-Release" versions are not stable and often have bugs.
 

source/docs/getting-started/installation/sw_install/orange-pi.rst

@@ -0,0 +1,27 @@
+Orange Pi Installation
+======================
+
+Downloading Armbian Bullseye CLI
+--------------------------------
+Download the latest release of the Armbian Bullseye CLI image from `here <https://redirect.armbian.com/region/NA/orangepi4-lts/Bullseye_current>`_.
+
+
+Flashing the Pi Image
+---------------------
+An 8GB or larger SD card is recommended.
+
+Use `Balena Etcher <https://www.balena.io/etcher/>`_ to flash an image onto a Orange Pi. Select the downloaded ``.zip`` file, select your microSD card, and flash.
+
+For more detailed instructions on using Etcher, please see the `Etcher website <https://www.balena.io/etcher/>`_.
+
+.. warning:: Using an older version of Balena Etcher may cause bootlooping (the system will repeatedly boot and restart) when imaging your Raspberry Pi. Updating to the latest Balena Etcher will fix this issue.
+
+Initial Setup
+-------------
+Insert the flashed microSD card into your Orange Pi and boot it up. The first boot may take a few minutes as the Pi expands the filesystem. Be sure not to unplug during this process.
+
+Plug your Orange Pi into a display via HDMI and plug in a keyboard via USB once its powered up. Complete the initial set up which involves creating a root password and adding a user, as well as setting localization language. Additionally, choose “bash” when prompted.
+
+Installing PhotonVision
+-----------------------
+From here, you can follow :ref:`this guide <docs/getting-started/installation/sw_install/other-coprocessors:Installing Photonvision>`.

source/docs/getting-started/installation/sw_install/other-coprocessors.rst

@@ -5,6 +5,9 @@ Other Debian-Based Co-Processor Installation
 
 .. note:: We'd love to have your input! If you get PhotonVision working on another coprocessor, consider documenting your steps and submitting a `docs issue <https://github.com/PhotonVision/photonvision-docs/issues>`_., `pull request <https://github.com/PhotonVision/photonvision-docs/pulls>`_ , or `ping us on Discord <https://discord.com/invite/wYxTwym>`_. For example, Limelight and Romi install instructions came about because someone spent the time to figure it out, and did a writeup.
 
+Installing PhotonVision
+-----------------------
+
 We provide an `install script <https://git.io/JJrEP>`_ for other Debian-based systems (with ``apt``) that will automatically install PhotonVision and make sure that it runs on startup.
 
 .. code-block:: bash
@@ -32,3 +35,5 @@ For example, from another Linux computer, run the following:
    $ sudo systemctl stop photonvision.service
    $ sudo mv [jar name].jar /opt/photonvision/photonvision.jar
    $ sudo systemctl start photonvision.service
+
+

source/docs/getting-started/installation/sw_install/raspberry-pi.rst

@@ -4,7 +4,9 @@ A Pre-Built Raspberry Pi image is available for ease of installation.
 
 Downloading the Pi Image
 ------------------------
-Download the latest release of the PhotonVision Pi image from the `releases page <https://github.com/PhotonVision/photonvision/releases>`_. You do not need to extract the downloaded ZIP file.
+Download the latest release of the PhotonVision Raspberry image from the `releases page <https://github.com/PhotonVision/photonvision/releases>`_. You do not need to extract the downloaded ZIP file.
+
+.. note:: Make sure you download the image that ends in '-raspi' or '-RasberryPi'.
 
 Flashing the Pi Image
 ---------------------
@@ -37,6 +39,6 @@ Once you find it, set the IP to a desired :ref:`static IP in PhotonVision. <docs
 Updating PhotonVision
 ---------------------
 
-Download the latest stable Raspberry Pi .jar (appended with -raspi at the end) from `our releases page <https://github.com/PhotonVision/photonvision/releases>`_, go to the settings tab, and upload the .jar using the Offline Update button.
+Download the latest stable xxxxx-LinuxArm64.jar from `our releases page <https://github.com/PhotonVision/photonvision/releases>`_, go to the settings tab, and upload the .jar using the Offline Update button.
 
 As an alternative option - Export your settings, reimage your coprocessor using the instructions above, and import your settings back in.

source/docs/getting-started/installation/sw_install/snakeyes.rst

@@ -34,7 +34,7 @@ Once you find it, set the IP to a desired :ref:`static IP in PhotonVision. <docs
 
 Updating PhotonVision
 ----------------------
-Download the latest stable Raspberry Pi .jar (appended with -raspi at the end) from `our releases page <https://github.com/PhotonVision/photonvision/releases>`_, go to the settings tab, and upload the .jar using the Offline Update button.
+Download the latest xxxxx-LinuxArm64.jar from `our releases page <https://github.com/PhotonVision/photonvision/releases>`_, go to the settings tab, and upload the .jar using the Offline Update button.
 
 As an alternative option - Export your settings, reimage your coprocessor using the instructions above, and import your settings back in.
 

source/docs/getting-started/installation/sw_install/windows-pc.rst

@@ -10,19 +10,15 @@ PhotonVision requires a JDK installed and on the system path. **JDK 11 is needed
 
 Downloading the Latest Stable Release of PhotonVision
 -----------------------------------------------------
-Download the latest stable .jar of PhotonVision from the `GitHub releases page <https://github.com/PhotonVision/photonvision/releases>`_.
-
-.. note:: Be sure not to download the .jar file with "-raspi" at the end as that is specifically meant for Raspberry Pi coprocessors.
-
-.. warning:: Be careful to pick the latest stable release. "Draft" or "Pre-Release" versions are not stable and often have bugs.
+Go to the `GitHub releases page <https://github.com/PhotonVision/photonvision/releases>`_ and download the winx64.jar file.
 
 Running PhotonVision
 --------------------
 To run PhotonVision, open a terminal window of your choice and run the following command:
 
 .. code-block::
 
-   > java -jar C:\path\to\photonvision\photonvision-xxx.jar
+   > java -jar C:\path\to\photonvision\NAME OF JAR FILE GOES HERE.jar
 
 If your computer has a compatible webcam connected, PhotonVision should startup without any error messages. If there are error messages, your webcam isn't supported or another issue has occurred. If it is the latter, please open an issue on the `PhotonVision issues page <https://github.com/PhotonVision/photonvision/issues>`_.