From 0048948102775946265191319456d15d21eee6bc Mon Sep 17 00:00:00 2001 From: Lillia Elaine <7863608+LilliaElaine@users.noreply.github.com> Date: Wed, 22 Oct 2025 12:16:34 -0400 Subject: [PATCH] Update README to have updated instructions --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dd03b9d..bfc6cc2 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,14 @@ Simple program to take and output the Bigscreen Beyond 2e cameras to a webserver to be used with eyetracking software. ## Usage +Pre-Compiled Binares are in the Releases Section, and can be run out of the box with `./go-bsb-cams` + +The code by default outputs to `localhost:8080/stream` but can be configured with the `-port` flag. + +To run or build the src with golang: + Clone This repo and get the dependencies with: `go get .` -To run, execute the following command within the root directory: `go run main.go` or build the package and run the resulting executable. +Execute the following command within the root directory: `go run main.go` to run as a go program -The code by default outputs to `localhost:8080/stream` but can be configured within the code. +Alternatively, the program can be built with `go build` and run via the resulting executable.