Compare commits

...

20 Commits

Author SHA1 Message Date
FTC Engineering
522eac0fb0 Update README.md 2018-11-12 10:03:00 -05:00
FTC Engineering
17c87b8b04 Update README.md 2018-10-18 16:12:44 -04:00
FTC Engineering
fbac67b4fe Update README.md 2018-10-18 14:15:00 -04:00
FTC Engineering
3791a0bc2a Update README.md 2018-10-12 21:11:13 -04:00
FTC Engineering
7d3159fc4c Update README.md 2018-09-13 11:28:58 -04:00
FTC Engineering
a816e47941 Update README.md 2018-09-13 11:28:06 -04:00
FTC Engineering
8bb52e4c16 Update README.md 2018-09-13 10:55:39 -04:00
FTC Engineering
cdf909eab4 Update README.md 2018-09-13 10:54:43 -04:00
FTC Engineering
a478acf440 Update README.md 2018-09-13 10:53:16 -04:00
FTC Engineering
665bfb93e9 Update README.md 2018-09-13 10:50:07 -04:00
FTC Engineering
b7a0428193 Update README.md 2018-09-13 10:47:30 -04:00
FTC Engineering
0a7fb8dad2 Update README.md 2018-09-13 10:46:22 -04:00
FTC Engineering
b4a35d0774 Update README.md 2018-09-13 10:45:44 -04:00
FTC Engineering
9970225e01 Update README.md 2018-09-13 10:43:05 -04:00
FTC Engineering
854b4e30f5 Update README.md 2018-09-13 10:42:22 -04:00
FTC Engineering
2c39e095c5 Update README.md 2018-09-13 10:41:33 -04:00
FTC Engineering
883696fac2 Update README.md 2018-09-13 10:34:48 -04:00
FTC Engineering
37ab1753dd Update README.md 2018-09-13 10:33:15 -04:00
FTC Engineering
01a1f0ef12 Update README.md 2018-09-13 09:28:39 -04:00
FTC Engineering
cd6530394b Update README.md 2018-09-13 09:21:01 -04:00

View File

@@ -1,11 +1,34 @@
# Welcome! # Welcome!
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 feature to report and track issues with the software. 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.
## Downloading the software ## Downloading the software
The software is available for download under the Releases page of this repository. Click on the "releases" link towards the upper right hand corner of the main page to navigate to the Release page. Browse the releases page for version you are looking forward, 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. Once you have downloaded the archive file, uncompress the file using the appropriate tool for your computer. 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>
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.
<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>
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.
## Documentation ## Documentation
Currently, the user documentation exists as a living Google Drive document. You can access the document using the following link: The user documentation can be found here:
&nbsp;&nbsp;[User Documentation for Scorekeeping Software](https://docs.google.com/document/d/1x5OHQiNgm70inQ-FRYEhM0RPY0hKwaQIH3_FfDnf1bw/edit?usp=sharing) &nbsp;&nbsp;[FTC Scorekeeper Manual](https://github.com/FIRST-Tech-Challenge/scorekeeper/files/2563026/FTC.Scorekeeper.Manual.v0.5.1.1.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>
<p align="center">Click on the "Issues" link to go to the Issues page.</p>
The developers of the software requested that if you encounter a bug, you copy and archive (compress into .zip form) the "db" subdirectory and then create an issue on the Issues database and attach the .zip file to the newly created issue and save the attachment with the issue. The "db" folder is located in the "lib" subfolder.
While you are editing your issue, if you click the link called "selecting them" towards the bottom of the issue window, a dialog box will appear. You can use this dialog box to select a local file from your computer to attach to the issue that you are editing.
<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>