Merge pull request #660 from ofekashery/master

Update readme to 2023/24 season

.github/ISSUE_TEMPLATE/documentation-request.md

@@ -0,0 +1,16 @@
+---
+name: Documentation Update Request
+about: Request an addition, correction or update to documentation
+title: ''
+labels: documentation
+assignees: ''
+
+---
+
+** Requested Change **
+What you would like to see updated (or added) to documentation
+
+** Relevant existing documentation **
+A link to any existing documentation, with page number if appropriate
+
+

.github/ISSUE_TEMPLATE/ftc-events-bug-report.md

@@ -0,0 +1,33 @@
+---
+name: FTC Events Bug Report
+about: Submit a bug in ftc-events.firstinspires.org (including ftc-api)
+title: ''
+labels: ftc-events, bug
+assignees: ''
+
+---
+<!--- DO NOT INCLUDE PRIVATE INFORMATION IN THIS ISSUE --->
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Device (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/ftc-events-feature-request.md

@@ -0,0 +1,20 @@
+---
+name: FTC Events Feature Request
+about: Suggest an idea for for ftc-events.firstinspires.org (including ftc-api)
+title: ''
+labels: ftc-events, enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

README.md

@@ -4,32 +4,58 @@ This is the software used to run **traditional** in-person events.
 
 If you are a mentor or team administrator trying to score **remote** event matches, go here: [FTC Remote Scoring](https://ftc-scoring.firstinspires.org)
 
-Full documentation can be found in the [FTC Scoring Team Guide](https://www.firstinspires.org/sites/default/files/uploads/resource_library/ftc/ftc-cloudscoring-team-user-guide.pdf)
-
-A video walkthrough can be found on YouTube: [Remote Event Scoring For Teams](https://www.youtube.com/watch?v=5pGDi_Kq7ks&list=PLEuGrYl8iBm48sXHM8wOIPECDvD1zGgr2)
+Full documentation can be found in the [FTC Scoring Team Guide](https://www.firstinspires.org/sites/default/files/uploads/resource_library/ftc/scoring-team-guide.pdf)
 
 # Welcome: Traditional Events
-This GitHub repository can be used to download the _FIRST_ Tech Challenge Live scorekeeper software.  Also, if you have a GitHub user account, you can use the ["Issues" database](https://github.com/FIRST-Tech-Challenge/scorekeeper/issues) to report and track issues with the software.
+
+This GitHub repository is used to [report and track issues](https://github.com/FIRST-Tech-Challenge/scorekeeper/issues) with the _FIRST_ Tech Challenge Live Scorekeeper Software.
 
 ## Downloading the software
-The software is available for download under the [Releases page](https://github.com/FIRST-Tech-Challenge/scorekeeper/releases) of this repository.  Click on the  ["releases" link](https://github.com/FIRST-Tech-Challenge/scorekeeper/releases) towards the upper right hand corner of the [main page](https://github.com/FIRST-Tech-Challenge/scorekeeper) to navigate to the [Releases page](https://github.com/FIRST-Tech-Challenge/scorekeeper/releases).
 
-<p align="center"><img src="https://github.com/FIRST-Tech-Challenge/WikiSupport/blob/master/scorekeeper/releasesLink.png" width="400"></p>
-<p align="center">Click on the "releases" link to go to the Releases page.</p>
+Starting with the 2022-2023 season, the scoring system is primarily available to download as an installer. The installers can be found at
+`https://ftc-scoring.firstinspires.org/local/<season>` (and `https://ftc-scoring.firstinspires.org/local/<season>-offseason` after the season's world championship when offseason events can be hosted).
 
-Browse the [Releases page](https://github.com/FIRST-Tech-Challenge/scorekeeper/releases) for the version that you are looking for, and click on the appropriate link to download the archived software.  The software is stored on the server as an archived .zip or .tar file.  Note that most users (Windows and Mac users especially) will want to download the .zip format archive file.  Once you have downloaded the archive file, uncompress the file using the appropriate tool on your computer.
+### Current Links
 
-<p align="center"><img src="https://github.com/FIRST-Tech-Challenge/WikiSupport/blob/master/scorekeeper/downloadZip.png" width="400"></p>
-<p align="center">Click on the file that you'd like to download.</p>
+| Game                              | Link                                                       |
+| --------------------------------- | ---------------------------------------------------------- |
+| **CENTERSTAGE (2023-2024)**       | https://ftc-scoring.firstinspires.org/local/2024           |
+| POWERPLAY (2022-2023) - Offseason | https://ftc-scoring.firstinspires.org/local/2023-offseason |
+| POWERPLAY (2022-2023)             | https://ftc-scoring.firstinspires.org/local/2023           |
 
-Note that you want to download the "FIRST-Tech-Challenge-Live" archive file, and not the "Source code" file.  The "Source code" file does not contain any usable content.
+The scoring system will autoupdate to the latest available version for the season on launch if connected to the internet.
+
+### Choosing the correct installer
+
+The website will detect the platform you are running on and offer a button to download for that platform.
+![Download Local Scoring System screenshot](https://ftc-scoring.firstinspires.org/uploads/076a1482-b74a-44c4-b5c4-a6bc506170f4)
+
+If you need to download for one system from another (e.g. the scoring computer runs Windows but you are downloading on a Mac to put on a flash drive), other systems can be found by clicking on "All platforms".
+![All platforms download section screenshot](https://ftc-scoring.firstinspires.org/uploads/fbcc1663-5c1f-4bfb-8fa0-b757a746adae)
+
+If you are downloading for macOS or for Linux and are unsure which download is correct for you, run `uname -m` in a terminal and select the corresponding download.
+
+> [!WARNING]
+> While we will address any issues reported through this repository for Linux, we are unable to provide Linux-specific event-day support and therefore encourage running the scoring system on Windows or macOS unless your event has volunteers sufficiently experienced in debugging issues on Linux.
+
+### Advanced installer
+
+In some cases you may not be able to run the provided installer (e.g. security policies on the scorekeeper computer). In those cases you can run the scoring system through a package that is similar to how it was provided in previous seasons.
+
+There is a download available under the "Advanced" dropdown that works on all platforms.
+![Advanced download section screenshot](https://github.com/FIRST-Tech-Challenge/scorekeeper/assets/3067361/9371f9c2-06f8-40b9-a06f-17e838c8fa44)
+
+> [!NOTE]
+> This requires a global installation of Java 17, which can be [downloaded and installed from here](https://www.azul.com/downloads/?version=java-17-lts&package=jre).
+
+To launch, extract the zip and open the `FTCLauncher` file on macOS/Linux or the `FTCLauncher.bat` file on Windows. This version of the scoring system still has the same auto-update feature as the installer version.
 
 ## Documentation
-The user documentation can be found here:
 
-&nbsp;&nbsp;[FTC Scorekeeper Manual](https://www.firstinspires.org/sites/default/files/uploads/resource_library/ftc/scorekeeper-manual.pdf)
+The user documentation can be found here: [FTC Scorekeeper Manual](https://www.firstinspires.org/sites/default/files/uploads/resource_library/ftc/scorekeeper-guide.pdf).
 
 ## Reporting Issues
+
 Click on the ["Issues" link](https://github.com/FIRST-Tech-Challenge/scorekeeper/issues) towards the upper left hand corner of the main page of this repository to navigate to the [Issue Tracking Database page](https://github.com/FIRST-Tech-Challenge/scorekeeper/issues). If you are logged in to your GitHub user account (which is available for free from GitHub) you can create and reply to issues in the database.
 
 <p align="center"><img src="https://github.com/FIRST-Tech-Challenge/WikiSupport/blob/master/scorekeeper/issues.png" width="400"></p>
@@ -41,4 +67,3 @@ While you are editing your issue, if you click the link called "selecting them"
 
 <p align="center"><img src="https://github.com/FIRST-Tech-Challenge/WikiSupport/blob/master/scorekeeper/selectingThem.png" width="600"></p>
 <p align="center">Click on the "selecting them" link to attach a local file to your issue.</p>
-