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

Update ReadMe.md #3534

Open
wants to merge 1 commit into
base: MCP/0031
Choose a base branch
from
Open

Update ReadMe.md #3534

wants to merge 1 commit into from

Conversation

casella
Copy link
Collaborator

@casella casella commented Jun 18, 2024

Added a short explanation in the Roadmap on how to actually read the proposal, which is not obvious at first sight.

@HansOlsson HansOlsson added the MCP0031 Base Modelica and MLS modularization (MCP-0031) label Jun 23, 2024
Copy link
Collaborator

@henrikt-ma henrikt-ma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two things:

  • This does not belong to the roadmap.
  • I'm not sure it's a great idea to recommend starting with the extremely dry grammar.md. I'd rather recommend directing readers to differences.md first, but if we can't agree on which one is better we could suggest them as equally good places to start.

@henrikt-ma
Copy link
Collaborator

Perhaps a better place to put the new text is under Summary, right before In a sentence (or two)?

If placed there, it would also be good to recommend reading the rest of the Summary and at least skimming the roadmap items before proceeding to the other documents.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
MCP0031 Base Modelica and MLS modularization (MCP-0031)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants