Skip to content

Conversation

@tschm
Copy link
Contributor

@tschm tschm commented Nov 10, 2025

Towards an updated README file

Copy link
Collaborator

@fkiraly fkiraly left a 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 poetry as a basic workflow, and possibly move to uv
  • pip should 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, uv should be directly shown if you want to show it.

@tschm
Copy link
Contributor Author

tschm commented Nov 11, 2025

Sorry, I need to get back into the habit of writing longer and more detailed descriptions. I tend to use coderabbitai for my projects

@tschm
Copy link
Contributor Author

tschm commented Nov 11, 2025

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

@fkiraly
Copy link
Collaborator

fkiraly commented Nov 11, 2025

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.

Copy link
Collaborator

@fkiraly fkiraly left a 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

@fkiraly fkiraly changed the title Readme [DOC] improvements to README.md Nov 13, 2025
@fkiraly fkiraly merged commit 6de3975 into PyPortfolio:main Nov 13, 2025
18 checks passed
@tschm tschm deleted the readme branch November 14, 2025 05:28
@tschm
Copy link
Contributor Author

tschm commented Nov 14, 2025

Not sure about binder. Surprised it still works. But somewhat obsolete now. Devcontainers have arrived.

@tschm
Copy link
Contributor Author

tschm commented Nov 14, 2025

More work on README needed but good step in the correct direction

@fkiraly
Copy link
Collaborator

fkiraly commented Nov 14, 2025

Not sure about binder. Surprised it still works.

Yes, I think it still works but servers have gotten slow. If you know a more modern alternative, I am all ears!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants