Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] README may need some love on installing requirements. #73

Open
epugh opened this issue Nov 26, 2024 · 1 comment
Open

[BUG] README may need some love on installing requirements. #73

epugh opened this issue Nov 26, 2024 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@epugh
Copy link

epugh commented Nov 26, 2024

What is the bug?

Right now the README lists out the install steps for various versions, and that takes up the bulk of the page.

Also, it doesn't reflect the 2.18 release.... It's hard to maintain.

How can one reproduce the bug?

Read the README ;-)

What is the expected behavior?

We need a more concise readme.

Do you have any additional context?

Simplify the maintence side of things!

@sstults
Copy link
Collaborator

sstults commented Nov 26, 2024

Maybe just list the most recent release in the installation command? There's probably some more things we can do, but that seems like a quick win.

@sstults sstults added documentation Improvements or additions to documentation and removed untriaged labels Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
Status: 🆕 New
Development

No branches or pull requests

2 participants