diff --git a/README.md b/README.md index bc26b80..d47b9a7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # jingleping-go -Ping images to the [IPv6 christmas tree](https://jinglepings.com). I wrote this application to draw a dabbing Pikachu and a dancing Sans to the video wall. +Ping images to the [IPv6 christmas tree](https://jinglepings.com). I wrote this application to draw a dabbing Pikachu and a dancing Sans to the video wall. Check the [Releases](https://github.com/ajmadsen/jingleping-go/releases) page for downloads. ![Screenshot of Video Board with Pikachu and Sans](static/tree.jpg) @@ -13,7 +13,7 @@ Usage of ./jingleping-go: -image string the image to ping to the tree -rate int - how many times to draw the image per second (default 100) + how many times to draw the image per second (default 5) -workers int the number of workers to use (default 1) -x int @@ -23,3 +23,17 @@ Usage of ./jingleping-go: ``` If the image is an animated GIF, the rate should be adjusted accordingly. By default, the application will send one ping per pixel per frame. If the rate is set to some value higher than the average frame delay, each pixel in the frame may be sent more than once, improving the fidelity of the animation. + +# Building + +You'll need Go (preferably 1.11 for module support). Clone the repository somewhere outside your `$GOPATH`, and run `go build`. + +``` +$ cd /tmp +$ git clone https://github.com/ajmadsen/jingleping-go +$ cd jingleping-go +$ go build +$ ./jingleping-go ... +``` + +Alternatively, run `go get -u github.com/ajmadsen/jingleping-go` to install to your `$GOPATH`, and find the installed binary at `$GOPATH/bin/jingleping-go`. diff --git a/main.go b/main.go index 7c8b841..f6e2446 100644 --- a/main.go +++ b/main.go @@ -23,7 +23,7 @@ var ( imageFlag = flag.String("image", "", "the image to ping to the tree") xOffFlag = flag.Int("x", 0, "the x offset to draw the image") yOffFlag = flag.Int("y", 0, "the y offset to draw the image") - rateFlag = flag.Int("rate", 100, "how many times to draw the image per second") + rateFlag = flag.Int("rate", 5, "how many times to draw the image per second") workersFlag = flag.Int("workers", 1, "the number of workers to use") )