search

GliderGeek / pocket2rm

get articles from read-later platform pocket to the remarkable paper tablet
MIT License
184 stars 15 forks source link

Add dependency installation instructions #8

Closed kathawala closed 3 years ago

kathawala commented 3 years ago

I'm using this code on my reMarkable tablet right now, it's great :)

While installing it, I was unsure of how to get all the dependencies for the builds (never used go before), eventually realized you need to run go get beforehand.

For non-go devs it might not be obvious that you need to run go get before any of the builds in the installation instructions, so this just makes that explicit

GliderGeek commented 3 years ago

thanks for the kind words and your contribution. the current implementation with a semi-colon between get and build suggests that it's a single command which can be copy-pasted in the terminal. however this doens't work for bash. maybe better to split in two separate ones:

thus: go get; go build main.go -> go get, go build main.go

GliderGeek commented 3 years ago

i myself am also not very experienced in go and think it should be possible to have an explicit list of dependencies (like python's requirements.txt). if someone wants to contribute that, that would be great

kathawala commented 3 years ago

Came back to this again today, and I noticed that go get; go build main.go works fine in bash? Am I missing something here?

I think this should allow a declarative solution for requirements / dependencies: https://golang.org/ref/mod#go-mod-file

GliderGeek commented 3 years ago

Sorry for the late reply. In the meantime a PR has been opened which incorporated the go get command in an install script, yielding this PR unnecessary.

The explicit dependency list would still be a good addition in the future.