diff options
| author | Karsten Heimrich <karsten.heimrich@qt.io> | 2025-12-02 14:28:43 +0100 |
|---|---|---|
| committer | Karsten Heimrich <karsten.heimrich@qt.io> | 2025-12-03 19:44:40 +0000 |
| commit | bb0a16c6f1dc90c47ea39a98128212022bac6b82 (patch) | |
| tree | 507f7bcf9e399a5a2a5255c0db195c6a44514526 | |
| parent | 672206ec491f95ef4707e960aa312e1fba9a17b7 (diff) | |
Make use ot the QtTemplateFile task to update README.md file
Replaces the hard-coded package name and version number in the README.
Change-Id: I507fd4fb4fe42edd66c801fdf3c24ca750eff8ed
Reviewed-by: Miguel Costa <miguel.costa@qt.io>
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | nuget/Qt.Bridge.DotNet.Package/Qt.Bridge.DotNet.Package.csproj | 32 | ||||
| -rw-r--r-- | nuget/Qt.Bridge.DotNet.Package/README.template.md (renamed from nuget/Qt.Bridge.DotNet.Package/README.md) | 4 |
3 files changed, 31 insertions, 6 deletions
@@ -19,3 +19,4 @@ include/* # Local nuget nuget/local/ +nuget/Qt.Bridge.DotNet.Package/README.md diff --git a/nuget/Qt.Bridge.DotNet.Package/Qt.Bridge.DotNet.Package.csproj b/nuget/Qt.Bridge.DotNet.Package/Qt.Bridge.DotNet.Package.csproj index d495ad9..1a9919e 100644 --- a/nuget/Qt.Bridge.DotNet.Package/Qt.Bridge.DotNet.Package.csproj +++ b/nuget/Qt.Bridge.DotNet.Package/Qt.Bridge.DotNet.Package.csproj @@ -1,6 +1,7 @@ <Project Sdk="Microsoft.NET.Sdk"> <Import Project="$([MSBuild]::GetPathOfFileAbove(qt_version.props))" /> + <Import Project="$([MSBuild]::GetPathOfFileAbove(qt_template.targets))" /> <PropertyGroup> <TargetFramework>net8.0</TargetFramework> @@ -103,10 +104,6 @@ <!-- 4) Native Qt.DotNet headers (added in target UpdatePackageFiles) --> - <!-- 5) README --> - <None Include="README.md" Pack="true" - PackagePath="" /> - </ItemGroup> <PropertyGroup> @@ -178,6 +175,33 @@ <None Remove="catalogs.json" /> </ItemGroup> + <ItemGroup> + <!-- Placholder - Do not remove! --> + <!-- Final README.md to be included in the NuGet package --> + <None Include="README.md" Pack="true" PackagePath="" Visible="false"/> + + <!-- Template remains in the project but is not packed into the NuGet --> + <None Include="README.template.md" Pack="false" /> + </ItemGroup> + + <Target Name="GenerateReadme" BeforeTargets="_GetPackageFiles"> + + <ItemGroup> + <!-- Tokens for README generation --> + <QtTemplateToken Remove="@(QtTemplateToken)" /> + <QtTemplateToken Include="__PACKAGE_ID__"> + <ReplacementValue>$(PackageId)</ReplacementValue> + </QtTemplateToken> + <QtTemplateToken Include="__PACKAGE_VERSION__"> + <ReplacementValue>$(PackageVersion)</ReplacementValue> + </QtTemplateToken> + </ItemGroup> + + <QtTemplateFile Template="README.template.md" + OutputFileName="README.md" + Tokens="@(QtTemplateToken)" /> + </Target> + <Target Name="UpdatePackageFiles" BeforeTargets="_GetPackageFiles"> <ItemGroup> <None Pack="true" Include="..\..\include\**\*" diff --git a/nuget/Qt.Bridge.DotNet.Package/README.md b/nuget/Qt.Bridge.DotNet.Package/README.template.md index d1312f7..24a2646 100644 --- a/nuget/Qt.Bridge.DotNet.Package/README.md +++ b/nuget/Qt.Bridge.DotNet.Package/README.template.md @@ -1,4 +1,4 @@ -# Qt.Bridge.DotNet - QML for .NET 8+ +# __PACKAGE_ID__ - QML for .NET 8+ Bring **QML/Qt Quick** to **C#/.NET** with a single package. This bundle ships: @@ -25,7 +25,7 @@ Bring **QML/Qt Quick** to **C#/.NET** with a single package. This bundle ships: ```bash # Project folder -dotnet add package Qt.Bridge.DotNet --prerelease +dotnet add package __PACKAGE_ID__ --version __PACKAGE_VERSION__ ``` --- |