Replaced by json config.

readme.md

@@ -1,3 +1,70 @@
-# POBounty Dashboard
+# GERS PO Dashboard
 
-Simple two scener game app using ebiten. Displays countdown until a given deadline specified in RFC3339 (/resources/settings/deadline.txt). Attempts to read scores for specific teams from Jira if such a connection is available. On timer expiry, transitions to end scene, displaying winners and associated points.
+The GERS Software PO Dashboard is intended to be a reusable board for displaying remaining time in a given work interval as well as tallying scores on accepted Jira issues. Written in go. Leverages ebitengine. Assets are a combination of original work in conjunction with free assets from itch.io.
+
+## Features
+* displays countdown timer (in working days, hours, minutes, seconds) until a given deadline
+* animated score bars and overall leaderboard
+* configurable teams, score tallying, score givers
+* customizable Jira criteria for score keeping
+* celebration/completion screen, with winners identified
+* 24hr-remaining mode (ominous background)
+* offline mode (for simulation)
+
+## Future Improvements:
+* configurable/customizable assets (the idea being teams can create their own)
+
+## Build Steps:
+
+Make sure you've got go/git installed.
+```
+git clone https://gitscm.mda.ca/brm_cg/sw-prototypes/gers-dashboard.git
+```
+
+```
+cd gers-dashboard
+```
+
+Retrieve module dependencies.
+```
+go mod tidy
+```
+
+And lastly build.
+```
+go build <targetname>
+```
+
+Alternatively you don't have to build and can run/debug in your favorite IDE. If you're using VS Code the following launch configuration may prove useful. Note the external console; required if you are attempting to connect to a live jira instance in order to enter credentials.
+
+```
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Launch Package",
+            "type": "go",
+            "request": "launch",
+            "mode": "auto",
+            "program": "${fileDirname}",
+            "console": "externalTerminal"
+        }
+    ]
+}
+```
+
+If you'd like to run this without connecting to Jira (simulated behaviours by keyboard only), you can clear the url entry in the config.json file (missing field or empty string will suffice). Keyboard inputs as follows:
+
+| Key | Description |
+| ----------- | ----------- |
+| Q | Quit |
+| P | Add points to all teams randomly |
+| L | Assign 200 points to all teams |
+| R | Advance deadline to next 24hrs 5s (to preview 24hr-remaining mode) |
+| E | Transitions to end-screen (expires timer immediately) |
+| . | Randomly select new background gradient (countdown only) |
+| ArrowUp | Increase animation cycle frequency (max = ebitengine ticks per second, and this project is configured to the default 60) |
+| ArrowDown | Decrease animation cycle frequency (min = 1) |
+
+
+![ebiten](/resources/images/ebiten.png?raw=true "ebiten")

resources/settings/deadline.txt

@@ -1 +0,0 @@
-2023-11-24T04:00:00.000Z