diff --git a/README.md b/README.md index 053c802..5d32aa7 100644 --- a/README.md +++ b/README.md @@ -146,3 +146,15 @@ streams don't work. ## Feature Requests I've built this out for my specific use case and released it to the public when I considered it feature complete. Suggestions are welcome for adding additional features. + +## Development Setup +1. Install [golang](https://go.dev/doc/install) +2. Install [taskfile.dev](https://taskfile.dev/installation/) on your machine. + +3. Run `task install_deps` in the root of this repo. + +4. Run `task run` in the root of this repo. + +If all passes without errors, you should be set to use this binary. Checkout the `taskfile.dev` for additional features +commands you can run. + diff --git a/taskfile.yaml b/taskfile.yaml new file mode 100644 index 0000000..99f43f4 --- /dev/null +++ b/taskfile.yaml @@ -0,0 +1,24 @@ +version: '3' + +tasks: + # Builds the go-dj binary + build: + cmds: + - go build -v -o go-dj . + - chmod +x go-dj + + # Installs dependencies necessary for go-dj to output audio + install_deps: + cmds: + - sudo apt install libasound2-dev libudev-dev pkg-config + + # Runs go-dj + run: + cmds: + - task: build + - ./go-dj --help + + # Run the tests + test: + cmds: + - go test -v ./content -run Test \ No newline at end of file