Update README to have updated instructions

This commit is contained in:
Lillia Elaine
2025-10-22 12:16:34 -04:00
committed by GitHub
parent 454d109bc4
commit 0048948102

View File

@ -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.