Allow README.md files in .kpars

[simonas-drauksas-sensmetry]

User story

As a systems engineer developing SysML v2 packages
I want to include a README with my package
So that the end users of my package can better understand the purpose and usage of my package.

Background

The current KerML clause 10.3 specifies that the .kpar file archive can only have the following files (and nothing else):

• Project files in one of the following model interchange formats: textual notation (.kerml or .sysml), .json, or .xmi
• .project.json
• .meta.json

The exact quote from the spec:

A project interchange file is contains a single project serialized as a set of model interchange files, archived using the ZIP format [ZIP]. The archive shall contain a model interchange file for each of the root namespaces in the project, each formatted in one of the formats listed in 10.2. In addition, the archive shall contain, at its top level, exactly one file named .project.json and exactly one file named .meta.json. A KerML project interchange file shall have the file extension .kpar (KerML Project Archive).

Other package managers

• Python's PyPI allows and encourages READMEs in plain text, Markdown, or reStructuredText
• npm allows and encourages READMEs in Markdown
• NuGet allows READMEs in Markdown
• Visual Studio Code Extension Marketplace allows and encourages READMEs in Markdown

Tasks

• Raise this issue at OMG
• Develop a Proof-of-Concept that packages a README.md file into the .kpar
• Develop a way for sysand.org public package index to automatically render the included README.md file on the package's page. (task for outside of this repository)

[tilowiklundSensmetry]

My reading of the spec is not that the archive cannot contain anything else. It simply requires certain things to be present.