FirelyTeam / firely-cql-sdk

BSD 3-Clause "New" or "Revised" License
30 stars 17 forks source link

Use dedicated README files for individual packages #564

Open and-hus opened 2 months ago

and-hus commented 2 months ago

Is your feature request related to a problem? Please describe. The repository contains a global README.md file, which nicely introduces the complete SDK and provides some generic information and links. Currently all assets/packages from the repository are configured to use this README.md file when packaging. This means, that this very generic README is also shown e.g. on nuget.org for each package (see e.g. HL7.Cql.Packaging).

I would propose to use dedicated README.md files for each package. This allows to provide more detailed and more specific documentation and information for the respective package.

Describe the solution you'd like I would propose to use dedicated README.md files for each package. This allows to provide more detailed and more specific documentation and information for the respective package.

I have prepared a small PR, providing an example for such a dedicated README.md file for the PackagerCli project, which builds into the HL7.Cql.Packaging nuget package: #563

Describe alternatives you've considered none (basically leave it as it is)

Additional context none

baseTwo commented 2 months ago

Related issues