Merge pull request #374 from ty-porter/master

Add issue template and version information

ISSUE_TEMPLATE.md

@@ -0,0 +1,35 @@
+<!-- Before submitting a new issue, check that it is not already solved! (https://github.com/MLB-LED-Scoreboard/mlb-led-scoreboard/issues?q=is%3Aissue) -->
+
+## This issue is a
+
+- [ ] Bug Report
+- [ ] Feature Request
+
+<!-- Filling out your complete hardware and software configuration is more likely to help project maintainers resolve your issue. You may omit configuration sections as needed if you are submitting a feature request. -->
+
+## Hardware Configuration
+
+- Raspberry Pi Revision (4B+/3B+/Zero/etc.):
+- Operating System:
+- Matrix size:
+- Display adapter (HAT/Bonnet/etc.):
+  - Additional information:
+- Power source(s):
+
+<!-- Additional display adapter information could include E-address line mod, GPIO 4/18 performance mod, etc. Omit this section if you are unsure. -->
+
+## Software Configuration
+
+<!-- Scoreboard version can be found by running `python version.py` from the project directory. -->
+
+- MLB LED Scoreboard Version:
+- Commands/arguments used to start the scoreboard:
+
+## Expected behavior
+<!-- What should happen? -->
+
+## Actual behavior
+<!-- What happens instead? -->
+
+## Additional Information
+<!-- If you have a specific error message or code, PLEASE post with your issue so project maintainers can easily diagnose the problem. -->

README.md

@@ -1,4 +1,5 @@
-# mlb-led-scoreboard [![Join Slack](https://img.shields.io/badge/slack-join-blue.svg)](https://mlb-led-scoreboard.herokuapp.com/)
+# mlb-led-scoreboard 
+![Current Version](https://img.shields.io/github/v/release/MLB-LED-Scoreboard/MLB-LED-Scoreboard) [![Join Slack](https://img.shields.io/badge/slack-join-blue.svg)](https://mlb-led-scoreboard.herokuapp.com/)
 
 ---------------
 
@@ -104,6 +105,12 @@ It will also install the following python libraries that are required for certai
 
 That should be it! Your latest version should now be working with whatever new fangled features were just added.
 
+#### Version Information
+
+You can check the version information for your installation of mlb-led-scoreboard by running `python3 version.py`.
+
+The latest version of the software is available [here](https://github.com/MLB-LED-Scoreboard/mlb-led-scoreboard/releases).
+
 #### Time Zones
 Make sure your Raspberry Pi's timezone is configured to your local time zone. They'll often have London time on them by default. You can change the timezone of your raspberry pi by running `sudo raspi-config`.
 

main.py

@@ -16,6 +16,7 @@
 from data.config import Config
 from renderers.main import MainRenderer
 from utils import args, led_matrix_options
+from version import SCRIPT_NAME, SCRIPT_VERSION
 
 try:
     from rgbmatrix import RGBMatrix, __version__
@@ -27,10 +28,6 @@
     emulated = True
 
 
-SCRIPT_NAME = "MLB LED Scoreboard"
-SCRIPT_VERSION = "5.0.4"
-
-
 def main(matrix, config_base):
 
     # Read scoreboard options from config.json if it exists

version.py

@@ -0,0 +1,6 @@
+SCRIPT_NAME = "MLB LED Scoreboard"
+SCRIPT_VERSION = "5.0.4"
+
+
+if __name__ == "__main__":
+    print(f"{SCRIPT_NAME} v{SCRIPT_VERSION}")