peru icon indicating copy to clipboard operation
peru copied to clipboard

Mention requirements more clearly in README

Open colindean opened this issue 4 years ago • 6 comments

I've nearly always had git available anywhere I was using Peru but found while setting up a new CI pipeline that Peru calls git via subprocess for caching.

This dependency is undeclared in the Homebrew formula but is declared in the AUR package. I'll update the Homebrew formula.

colindean avatar Feb 25 '22 00:02 colindean

Opened https://github.com/Homebrew/homebrew-core/pull/95810

colindean avatar Feb 25 '22 00:02 colindean

The first paragraph of the "Installation" section mentions this requirement. Do you think we should clarify it?

oconnor663 avatar Feb 25 '22 19:02 oconnor663

Yes. I missed it and Homebrew missed it although whoever wrote The Homebrew formula may have simply assumed that whatever git Homebrew is relying on was adequate and didn't need to be an explicit dependency.

Minimally, I think it's worth clarifying that it's needed even if you're not pulling from a git repository.

colindean avatar Feb 25 '22 19:02 colindean

I need to resolve the conflicts created by my other PR getting merged so I'll revisit this I'm going to finish brewing my coffee.

colindean avatar Feb 25 '22 19:02 colindean

Fixed and ready for review. I chose to list the requirements and then call it out again in the pip section in case someone looks it up fast and misses the previous list.

colindean avatar Feb 25 '22 19:02 colindean

This is ready!

colindean avatar Mar 19 '22 19:03 colindean

This is ready!

colindean avatar Oct 05 '22 17:10 colindean

Thank you! Sorry for dropping the ball on this one.

oconnor663 avatar Oct 05 '22 19:10 oconnor663