search

kimtore / pms

Practical Music Search is an interactive Vim-like console client for the Music Player Daemon.
https://ambientsound.github.io/pms/
MIT License
249 stars 23 forks source link

Updates README #104

Closed xamebax closed 6 years ago

xamebax commented 6 years ago

Update README with instructions on setting up workstation for contributors.

codecov-io commented 6 years ago

Codecov Report

Merging #104 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #104   +/-   ##
=======================================
  Coverage   53.81%   53.81%           
=======================================
  Files          51       51           
  Lines        1797     1797           
=======================================
  Hits          967      967           
  Misses        807      807           
  Partials       23       23

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update bc0b606...004938b. Read the comment docs.

kimtore commented 6 years ago

Thanks, it's good to remove confusion about how to get the build working.

tremby commented 6 years ago

I checked out the upstream, then when I wanted to start making contributions, forked the repo and rearranged the remotes in the git repository, so the repo was still at its original location (ambientsound). But this is certainly a more direct route.

I would have made a relative symlink rather than an absolute one:

ln -s ../[yourgithubhandlegoeshere]/pms $GOPATH/src/github.com/ambientsound/pms
kimtore commented 6 years ago

What do you mean by rearranging the remotes?

tremby commented 6 years ago

I mean I started with a clone of your repository, then edited .git/config and renamed the remote from "origin" to "upstream", then did git remote add origin git@github.com/tremby/pms.git and set up branch tracking as appropriate.

All I mean to say is that I didn't come up against this particular issue because of the (convoluted) way I set up my dev environment.

kimtore commented 6 years ago

Please correct me if I'm wrong, but that's not what this patch addresses. See sample output below for what kind of error you'd get by not having aforementioned symlink in place.

kimt@nova ~/go/src/github.com $ mv ambientsound/ foobar
kimt@nova ~/go/src/github.com $ cd foobar/pms/
kimt@nova ~/go/src/github.com/foobar/pms $ make install
go install -ldflags="-X main.buildVersion=c605245"
main.go:9:2: cannot find package "github.com/ambientsound/pms/console" in any of:
        /usr/lib/go-1.8/src/github.com/ambientsound/pms/console (from $GOROOT)
        /home/kimt/go/src/github.com/ambientsound/pms/console (from $GOPATH)
main.go:10:2: cannot find package "github.com/ambientsound/pms/pms" in any of:
        /usr/lib/go-1.8/src/github.com/ambientsound/pms/pms (from $GOROOT)
        /home/kimt/go/src/github.com/ambientsound/pms/pms (from $GOPATH)
main.go:11:2: cannot find package "github.com/ambientsound/pms/version" in any of:
        /usr/lib/go-1.8/src/github.com/ambientsound/pms/version (from $GOROOT)
        /home/kimt/go/src/github.com/ambientsound/pms/version (from $GOPATH)
main.go:12:2: cannot find package "github.com/ambientsound/pms/xdg" in any of:
        /usr/lib/go-1.8/src/github.com/ambientsound/pms/xdg (from $GOROOT)
        /home/kimt/go/src/github.com/ambientsound/pms/xdg (from $GOPATH)
Makefile:8: recipe for target 'install' failed
make: *** [install] Error 1
tremby commented 6 years ago

I understand that.

I was pointing out how I didn't come across this issue: I had an "ambientsound" directory from the beginning, even though it now points to my own fork of the repository.

Another way to do it would be to make the ambientsound directory and then check out your fork within that.