bkuhlmann / pennyworth Goto Github PK

Overview

This issue is relatively simple, just a doc observation and concern since I am not a Frum user.

The README indicates that Frum is a requirement at https://github.com/bkuhlmann/pennyworth/blame/main/README.adoc#L39, but that other version managers are possible at https://github.com/bkuhlmann/pennyworth/blame/main/README.adoc#L209.

I use asdf, a version manager for any/all languages. The former indicates asdf is incompatible; the latter indicates it's compatible.

Screenshots/Screencasts

N/A

Steps to Recreate

1. View the readme at https://github.com/bkuhlmann/pennyworth

Desired Behavior

The README should be consistent and explicit concerning its requirements/dependencies. Is a ruby version manager a hard requirement or just having the ruby binary in the path? Does any version manager work?

Option 1

1. Update line 39 to indicate that a version manager is optional, but that documentation for this project references only Frum.

• Line 209 seems to indicate that having Ruby in your PATH is the only requirement.. is this true?

Option 2

1. Update line 209 to indicate Frum is a hard dependency

Option 3

1. Update line 39 to indicate that a version manager is required but that documentation for this project references only Frum.

Environment

N/A

Overview

Links in the Other section 404

Screenshots/Screencasts

Steps to Recreate

Click on one of the links

Desired Behavior

To see the linked resource.

Environment

MacOS, I'm using Brave.