From 22fd30127b81b39f5c2f03352c81ce26556947e6 Mon Sep 17 00:00:00 2001 From: Justin Fortin Date: Sat, 26 Jan 2019 15:55:43 -0500 Subject: [PATCH] Create README.md --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..05361a4 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# TBA Match Schedule Download +Downloads match schedules from The Blue Alliance and exports the result to a CSV. +Adds a blank column after each team number to assign a team member to scout the match. + +## Usage Guide + +Get the schedule for an event: + +`TBAMatchScheduleDownload.exe -event 2019gadal` + +Get the schedule for an event and filter for a specific team number: + +`TBAMatchScheduleDownload.exe -event 2019gadal -team 2974` + +View help: + +`TBAMatchScheduleDownload.exe --help` + +The CSV will be placed in the directory the command is run in with a name based on the event and team number. +If there is no event schedule available the resulting CSV file will be empty. + +## Command Line Arguments + +- event (required) + - Event code from The Blue Alliance. + - Example: For https://www.thebluealliance.com/event/2019gadal the event code is 2019gadal +- team (optional) + - Filter the schedule for a specific team number + - Example: 2974 + +## Building + +Windows builds available on the [Releases](https://github.com/fortinj1354/TBAMatchScheduleDownload/releases) page. + +Built on Go 1.11.5, can be built for any OS by using the standard [build](https://golang.org/pkg/go/build/) command.