Skip to content

Commit

Permalink
add taskfile.dev & update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jmillerv committed Jul 31, 2023
1 parent fb3bfa9 commit f7b8f50
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ This is the milestone where I throw tickets that I may pull into current release
### [Longshots](https://github.com/jmillerv/go-dj/milestone/3)
This is board is where neat ideas get thrown, but realistically won't be implemented anytime soon.



## Config Setup

go-dj consumes a file called `config.yml` the daemon searches for this file in the root of the directory
Expand Down Expand Up @@ -146,3 +148,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.

24 changes: 24 additions & 0 deletions taskfile.yaml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit f7b8f50

Please sign in to comment.