docs: Use dedicated README file for PackerCLI project #563
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 thisREADME.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.
As an example, this PR adds a dedicated
README.md
for the PackagerCli project, which builds into the HL7.Cql.Packaging nuget package. The project configuration is modified to use this dedicated README instead of the global README which is configured via thecql-sdk.props
file that is imported at the top of the csproj-file.When adopting this approach for all projects, we might even remove the inclusion of the global README in the
cql-sdk.props
file and just go with project specific includes. This would avoid theRemove
step.