-
Notifications
You must be signed in to change notification settings - Fork 877
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
Update Schelling Readme.md #2406
Conversation
This works. We have a pattern of having an installation section in the readme though -- I think we should keep that pattern. |
My concern with adding it to the readme's for all examples is the same as my concern with requirements.txt in all examples. It results in duplication of text, which is easy to miss and annoying to maintain. I agree, however, that it would be good to be clear somewhere that these examples ship with mesa and require mesa to be installed. Looking at the current docs, I noticed that Using Mesa on the landing page covers installing mesa, but also showcases how to run an example. First, this example is outdated and needs to be removed. Might it be a solution to update this text using one of the basic examples? We could then add a link here also to the TOC for all examples that ship with mesa. Alternatively, what about including some additional text in the TOC for examples? It would be easy to add a paragraph at the top with installation instructions and run instructions that is valid for all examples. |
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.
One minor nitpick, otherwise good!
Co-authored-by: Ewout ter Hoeven <[email protected]>
@jackiekazil I am merging these PRs and will add your point on installation instructions to the tracking issue. My current inclination is to address it at the level of the TOC for all examples. This page needs work anyway because it should be tied to the readme at the root of the examples folder. |
This updates the Schelling readme. It has the correct file names for all files. It also removes the text on requirements.txt since this file is not included.