Include readme and license in release packages - #117
Open
Bazooper-blip wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #92.
Release packages currently contain just the BPL, the server jar, and the install scripts, with nothing explaining what the zip is or how to install it.
scripts/TEMPLATE_README.md, rendered into each package asREADME.mdwith the version and Delphi version substituted. It briefly describes DelphiLint, lists the package contents, states the system requirements, and gives the install steps plus links to the configuration guide, FAQ, and issue tracker.LICENSE.txtinto each package, which also seems prudent for LGPL-licensed binaries.Testing: verified the template substitution produces a complete README with no leftover placeholders; the packaging changes are two
Copy-Item/Set-Contentcalls inNew-PackageFolder.