You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sdk/template-dpg/Azure.Template.Generated/README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# README.md template
2
2
3
-
Use the guidelines in each section of this template to ensure consistency and readability of your README. The README resides in your package's GitHub repository at the root of its directory within the repo. It's also used as the package distribution page (NuGet) and as a Quickstart on docs.microsoft.com. See [Azure.Template.LLC/README.md](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/template-LLC/Azure.Template.LLC/README.md) for an example following this template.
3
+
Use the guidelines in each section of this template to ensure consistency and readability of your README. The README resides in your package's GitHub repository at the root of its directory within the repo. It's also used as the package distribution page (NuGet) and as a Quickstart on docs.microsoft.com. See [Azure.Template.Generated/README.md](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/template-dpg/Azure.Template.Generated/README.md) for an example following this template.
4
4
5
5
**Title**: The H1 of your README should be in the format: `# [Product Name] client library for [Language]`
6
6
@@ -16,7 +16,7 @@ Use the guidelines in each section of this template to ensure consistency and re
16
16
* Next, add a **bulleted list** of the **most common tasks** supported by the package or library, prefaced with "Use the client library for [Product Name] to:". Then, provide code snippets for these tasks in the [Examples](#examples) section later in the document. Keep the task list short but include those tasks most developers need to perform with your package.
17
17
* Include this single line of links targeting your product's content at the bottom of the introduction, making any adjustments as necessary:
> TIP: Your README should be as **brief** as possible but **no more brief** than necessary to get a developer new to Azure, the service, or the package up and running quickly. Keep it brief, but include everything a developer needs to make their first API call successfully.
22
22
@@ -40,7 +40,7 @@ If your library requires authentication for use, such as for Azure services, inc
40
40
41
41
For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object.
Copy file name to clipboardExpand all lines: sdk/template-dpg/Azure.Template.Generated/src/Azure.Template.Generated.csproj
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
<ProjectSdk="Microsoft.NET.Sdk">
2
2
<PropertyGroup>
3
-
<Description>This is a LLC template project to demonstrate how to create a package that uses code generation as well as use for testing our build and release pipelines</Description>
<Description>This is a template project to demonstrating how to create a package that uses Azure SDK code generation to create a library for a data plane Azure service. It includes basic templates for setting up build and release pipelines, live and recorded tests, as well as Samples, README, and Changelog files.</Description>
4
+
<AssemblyTitle>Azure SDK Code Generation Template for Azure Data Plane</AssemblyTitle>
0 commit comments