commit 86683d4abf533e1258e25180cca000a8d19fc884 from: Witcher01 date: Sun Jan 30 12:07:26 2022 UTC update README, add Makefile commit - ebde964eeb9787d28a364474808e00df03bf19a0 commit + 86683d4abf533e1258e25180cca000a8d19fc884 blob - 209b048228aed59c4b7bec10a3221d479f964310 blob + d29108ee7a502068c203483dd17872b057d7de99 --- README.md +++ README.md @@ -2,19 +2,32 @@ discord_sr talk to the speedrun.com REST API via srapi and posts the formatted result to a discord channel. +## Compiling -# Requirements +Install the dependencies: -The Go compiler +- go -# Compiling discord_sr +Then compile discord_covid19: -`go build main.go` +``` +go build main.go +``` -# Running discord_sr +## Usage -`./main --token ` +``` +./main --token +``` -# Usage +## Usage For usage help send a command to the bot (currently one of `*records`, `*top`, and `*wr`) and read the help. + +## Resources + +Send patches and questions to [~witcher/public-inbox@lists.sr.ht](https://lists.sr.ht/~witcher/public-inbox). + +Instructions for preparing a patch are available at [git-send-email.io](https://git-send-email.io). + +Bugs and todo can be found at [~witcher/discord_sr](https://todo.sr.ht/~witcher/discord_sr). blob - /dev/null blob + fdcdd70edc5e05b568eba2c27c222af10411be35 (mode 644) --- /dev/null +++ Makefile @@ -0,0 +1,21 @@ +GO=go +SOURCES=$(wildcard *.go) +BIN=discord_sr + +default: build + +all: clean build + +clean: + rm -rf $(BIN) + +build: $(BIN) + +fmt: + $(GO) fmt $(SOURCES) + +tidy: + $(GO) mod tidy + +$(BIN): $(SOURCES) + $(GO) build -o $@