Skip to content

Commit

Permalink
audioc: fix comments and update README build/install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
rolyatsats committed Dec 9, 2019
1 parent ca66e4a commit eb52536
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 7 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
vendor/
audioc
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ representing the year `1977`.
This tool depends on `ffmpeg` and `ffprobe` binaries installed or included
within same folder, which are used to process the audio files and artwork.

Information on how to download `ffmpeg`:
To download `ffmpeg`:
[https://ffmpeg.org/download.html](https://ffmpeg.org/download.html)

The `metaflac` binary needs to be installed or included to support album
Expand All @@ -78,7 +78,7 @@ embedding will be skipped, but the program will continue without error.

The `metaflac` binary is part of the `flac` package.

Information on how to download `flac`:
To download `flac`:
[https://xiph.org/flac/download.html](https://xiph.org/flac/download.html)

## Mode
Expand Down Expand Up @@ -135,7 +135,7 @@ be undone.

## Developing

Instructions on how to: [Install Go and Dep](docs/INSTALL_GO_DEP.md)
How to: [Install Go and Dep](docs/INSTALL_GO_DEP.md)

### Building

Expand All @@ -153,7 +153,11 @@ Ensure dependencies are installed and up-to-date with `dep`, run:

From within source path, to build the binary, run:

go install
go build -o audioc cmd/*.go

To install the binary, run:

go build -o $GOPATH/bin/audioc cmd/*.go

To test by displaying usage, run:

Expand All @@ -167,7 +171,7 @@ From within source path, run:

### Contributing

Instructions on how to: [Submit a Pull Request](docs/SUBMIT_PR.md)
How to: [Submit a Pull Request](docs/SUBMIT_PR.md)

## License

Expand Down
2 changes: 1 addition & 1 deletion audioc.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ func (a *audioc) Process() error {
}

// group files by parent directory; call a.processBundle
// a.processBundle found within audioc/folder.go
// a.processBundle found within bundle.go
err = fsutil.BundleFiles(a.DirEntry, a.Files, a.processBundle)
if err != nil {
return err
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion cmd/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ func main() {
log.Fatal(err)
}

// audioc.New & a.Process found within audioc/audioc.go
// audioc.New & a.Process found within ../audioc.go
a := audioc.New(c, ffm, ffp)

err = a.Process()
Expand Down

0 comments on commit eb52536

Please sign in to comment.