Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
frank-weinberg committed May 12, 2024
1 parent d0c6a28 commit 8b7a3b7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions html/documentation/wiki-snapshot.html
Original file line number Diff line number Diff line change
Expand Up @@ -706,7 +706,7 @@
<div class="nav-container">
<div class="nav-inner" id="scroll-spy" style="width: min-content; overflow: auto; top: 60px; bottom: 0; padding 10px 0 10px 0;">
<span class="toc">Table of contents</span>
<p>This document is a snapshot of the <a href="https://github.com/rollerderby/scoreboard/wiki">CRG Wiki</a> bundled with the v2023.5 release of CRG. If you have internet access it is recommended that you refer to the online version of the Wiki as it may contain relevant updates.</p>
<p>This document is a snapshot of the <a href="https://github.com/rollerderby/scoreboard/wiki">CRG Wiki</a> bundled with the v2023.6 release of CRG. If you have internet access it is recommended that you refer to the online version of the Wiki as it may contain relevant updates.</p>
<h3 id="howtos">Howtos</h3>
<ul class="nav"><li><strong><a href="#Installing-the-Scoreboard-Software">Installing the Scoreboard Software</a></strong><ul class="nav"><li><span>Instructions for getting the software installed and running on a standalone computer to provide a functioning scoreboard.</span></li></ul></li><li><strong><a href="#Quick-Start-Guide">Quick Start Guide</a></strong><ul class="nav"><li><span>Basic information to run a game with only what is mandatory for a regulation game. See the pages below for the full feature set.</span></li></ul></li><li><strong><a href="#Preparing-a-Game">Preparing a Game</a></strong></li><li><strong><a href="#Scoreboard-Operation">Scoreboard Operation</a></strong></li><li><strong><a href="#Configuring-Hotkeys">Configuring Hotkeys</a></strong></li><li><strong><a href="#Using-the-Scoreboard-on-a-Network">Using the Scoreboard on a Network</a></strong></li><li><strong><a href="#Penalty-Tracking">Penalty Tracking</a></strong></li><li><strong><a href="#Lineup-Tracking">Lineup Tracking</a></strong></li><li><span>The </span><strong>Penalty Lineup Tracking</strong> interface combines the PT and LT inputs for one team on a single screen. See those pages for info how to operate it.</li></ul><h3 id="tips-tricks">Tips &amp; Tricks</h3>
<ul class="nav"><li><strong><a href="#Scoreboard-Best-Practices">Scoreboard Best Practices</a></strong></li><li><strong><a href="#Graphics">Graphics</a></strong><ul class="nav"><li><span>Information on graphics for use with CRG, such as team logos and sponsor banners.</span></li></ul></li><li><strong><a href="#External-Links">External Links</a></strong><ul class="nav"><li><span>Links to other sites with information about CRG Scoreboard.</span></li></ul></li></ul><h3 id="details-about-screens-tabs">Details about Screens / Tabs</h3>
Expand Down Expand Up @@ -2175,7 +2175,7 @@ <h2 id="games-teams-rulesets-and-operators-sections">Games, Teams, Rulesets, and
<p>Clone or download the sourcecode and change into the directory containing the source. To build CRG simply run <code>ant</code>. This will also run the bundled tests; if you want to skip those you can run <code>ant compile</code> instead.
If you want to create a zip archive that you can install on other computers, run <code>ant zip</code> instead. The archive will be placed in the folder <code>release</code>.</p>
<p class="page" id="Custom-Screen-Creation-Tutorial"></p><h1>Custom Screen Creation Tutorial</h1>
<p>All CRG frontend screens are web pages. This tutorial constructs a simple example screen as an illustration of how to construct CRG frontend pages. It assumes you already have CRG version 5 installed on your computer.</p>
<p>All CRG frontend screens are web pages. This tutorial constructs a simple example screen as an illustration of how to construct CRG frontend pages. It assumes you already have the latest CRG version installed on your computer.</p>
<p>The only Javascript add-on used by CRG is jQuery. While it would certainly be possible to write a custom page without using it, because it is universally used by the existing CRG codebase, this tutorial will also employ it. (Plus, it really DOES make things easier.)</p>
<p>While you can create the files for this tutorial anywhere on your computer, best practice would be the subdirectory of the /html/custom/ directory of your scoreboard installation that fits the purpose of the screen.</p>
<h2 id="html-template">HTML Template</h2>
Expand Down

0 comments on commit 8b7a3b7

Please sign in to comment.