-
Notifications
You must be signed in to change notification settings - Fork 1.1k
[DOC] improvements to README.md #658
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
Conversation
fkiraly
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally, it would be much appreciated if in the PR description you summarize the main changes.
- Agreed on removing
poetryas a basic workflow, and possibly move touv pipshould be showcased as primary workflow as it is universally compatible- good catch on the incorrect pypi package name, it should be all lower case!
- disagreed on moving to makefile. This is not operating system independent! Make only works on some operating systems. Instead,
uvshould be directly shown if you want to show it.
|
Sorry, I need to get back into the habit of writing longer and more detailed descriptions. I tend to use coderabbitai for my projects |
|
I hesitate to use uv directly. My experience was that people struggle to install it and then they would argue that they are forced to learn a new tool. Make is a great way to hide all of this from them |
Yes, but make does not work on all operating systems. That imo makes it a no-go for a default recommended workflow. Whatever code is on the readme must work for nearly everyone. |
fkiraly
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. I made small changes:
- restore the binder link - still works, why delete it?
- changed makefile to basic pip so it works for everyone
|
Not sure about binder. Surprised it still works. But somewhat obsolete now. Devcontainers have arrived. |
|
More work on README needed but good step in the correct direction |
Yes, I think it still works but servers have gotten slow. If you know a more modern alternative, I am all ears! |
Towards an updated README file