reckoner icon indicating copy to clipboard operation
reckoner copied to clipboard

Documentation: Quickstart Installation instructions are unclear

Open tofarr opened this issue 1 year ago • 2 comments

What happened?

All quick start instructions seem to start at the point where a user already has the cli downloaded, but I couldn't find specific instructions on how to actually install this tool. (Something like pip install reckoner or brew install reckoner?)

Do you have an installer? I have found folks doing...

curl -L "https://github.com/FairwindsOps/reckoner/releases/download/v6.0.0/reckoner_6.0.0_linux_amd64.tar.gz" > reckoner.tar.gz
tar -xvf reckoner.tar.gz
sudo mv reckoner /usr/local/bin/reckoner

But this seems environment specific. (And I'm trying on mac os and don't see a build for it.)

What did you expect to happen?

It would be nice to see instruction to install the tool

How can we reproduce this?

Go to: https://github.com/FairwindsOps/reckoner?tab=readme-ov-file or: https://reckoner.docs.fairwinds.com/usage/#course-yaml-definition

There are no instructions on how to actually install this.

Version

6.0.0

Search

  • [X] I did search for other open and closed issues before opening this.

Code of Conduct

  • [X] I agree to follow this project's Code of Conduct

Additional context

No response

tofarr avatar Sep 11 '24 06:09 tofarr