search

bemasher / rtlamr

An rtl-sdr receiver for Itron ERT compatible smart meters operating in the 900MHz ISM band.
GNU Affero General Public License v3.0
2.18k stars 247 forks source link

Update README.md #211

Closed ckartchner closed 2 years ago

ckartchner commented 2 years ago

Had some fun using this project today. Thanks for sharing it!

As someone completely new to the project, and to the Go programming language, I have a few suggestions for the README file to hopefully provide a smoother introduction to the next user of the project.

When I installed the executable, I was presented with a warning that go get is deprecated. The new syntax is to use go install.

Since a GOPATH isn't required, or setup by default, I wasn't sure where my binary files were landing until looking at the go docs. I made updates assuming the most common user of the project is like me and inexperienced with Go and will not have directly interacted with the language prior to running this software.

I also added a short gif showing what successful execution looked like. I generally find it can be very helpful to have a visual example of what a successful execution looks like including the successful capture of a message.

bemasher commented 2 years ago

Sorry for the long response time. Would you be willing to provide a redacted version of your video? I'm not too keen on including meter ID's, even if you give me permission to do it.

ckartchner commented 2 years ago

No worries about the response time. :smile:

I redacted the meter ID from the animation and description. I also rebased the commits so there is no history of that ID in the repo.

bemasher commented 2 years ago

Perfect, merging.