Skip to content

Commit bc5bd9a

Browse files
committed
Fix package readme packing and refresh Docs template
Exclude Docs/*.md from None so the nested Docs/readme.md no longer wins PackageReadmeFile over the project readme. Align the gen-readme template with the main docs header and OSMF/sponsors sections.
1 parent 1373cd3 commit bc5bd9a

2 files changed

Lines changed: 25 additions & 11 deletions

File tree

src/VisualStudio/Docs/readme.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
<h1 id="vs"><img src="https://raw.githubusercontent.com/devlooped/dotnet-vs/main/docs/img/icon.svg" alt="icon" height="32" width="32" style="vertical-align: text-top; border: 0px; padding: 0px; margin: 0px"> vs</h1>
2-
3-
A global tool for running, managing and querying Visual Studio installations
1+
![Icon](https://raw.githubusercontent.com/devlooped/dotnet-vs/main/docs/img/icon-32.png) dnx vs
2+
============
43

54
[![Version](https://img.shields.io/nuget/v/vs.svg?color=royalblue)](https://www.nuget.org/packages/vs)
65
[![Downloads](https://img.shields.io/nuget/dt/vs.svg?color=darkmagenta)](https://www.nuget.org/packages/vs)
@@ -17,9 +16,12 @@ dnx vs -- [command] [options]
1716
To get the CI version:
1817

1918
```
20-
dnx vs --prerelease --add-source https://pkg.kzu.app/index.json -- [command] [options]
19+
dnx vs --prerelease --source https://pkg.kzu.app/index.json -- [command] [options]
2120
```
2221

22+
<!-- #content -->
23+
A global tool for running, managing and querying Visual Studio installations
24+
2325
Command line parsing is done with [System.CommandLine](https://www.nuget.org/packages/System.CommandLine),
2426
with a compatibility layer that still accepts common legacy forms such as `-flag`, `--flag`, `/flag`,
2527
`-flag=value`, `--flag=value`, `-flag:value`, `--flag:value`, and bare channel/SKU/workload shortcuts.
@@ -59,11 +61,22 @@ intuitive command line, such as `dnx vs -- install +mobile -sku:enterprise` or `
5961
(runs the VS with the mobile workload installed). The *modify* command uses `+` and `-`
6062
prefix to add or remove workloads respectively, for example.
6163

64+
<!-- #content -->
65+
---
66+
<!-- include https://github.com/devlooped/.github/raw/main/osmf.md -->
67+
## Open Source Maintenance Fee
68+
69+
To ensure the long-term sustainability of this project, users of this package who generate
70+
revenue must pay an [Open Source Maintenance Fee](https://opensourcemaintenancefee.org).
71+
While the source code is freely available under the terms of the [License](license.txt),
72+
this package and other aspects of the project require [adherence to the Maintenance Fee](osmfeula.txt).
6273

63-
## Sponsors
74+
To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/devlooped) at the proper
75+
OSMF tier. A single fee covers all of [Devlooped packages](https://www.nuget.org/profiles/Devlooped).
6476

65-
<h3 style="vertical-align: text-top" id="by-clarius">
66-
<img src="https://raw.githubusercontent.com/devlooped/oss/main/assets/images/sponsors.svg" alt="sponsors" height="36" width="36" style="vertical-align: text-top; border: 0px; padding: 0px; margin: 0px">&nbsp;&nbsp;by&nbsp;<a href="https://github.com/clarius">@clarius</a>&nbsp;<img src="https://raw.githubusercontent.com/clarius/branding/main/logo/logo.svg" alt="sponsors" height="36" width="36" style="vertical-align: text-top; border: 0px; padding: 0px; margin: 0px">
67-
</h3>
77+
<!-- https://github.com/devlooped/.github/raw/main/osmf.md -->
78+
---
79+
<!-- include https://github.com/devlooped/sponsors/raw/main/footer.md -->
80+
# Sponsors
6881

6982
*[get mentioned here too](https://github.com/sponsors/devlooped)!*

src/VisualStudio/VisualStudio.csproj

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,10 @@ See full documentation at $(PackageProjectUrl).
6060
</ItemGroup>
6161

6262
<ItemGroup>
63-
<None Remove="Docs\alias.md" />
64-
<None Remove="Docs\client.md" />
65-
<None Include="readme.md" PackagePath="readme.md" Pack="true" />
63+
<!-- Docs/*.md are EmbeddedResource only; keep them out of None so nested
64+
Docs/readme.md cannot compete with the package PackageReadmeFile. -->
65+
<None Remove="Docs\*.md" />
66+
<None Update="readme.md" PackagePath="readme.md" Pack="true" />
6667
</ItemGroup>
6768

6869
<ItemGroup>

0 commit comments

Comments
 (0)