Edit README.md file in Visual Studio

A good README.md is the front door of any repository. You don't need to leave Visual Studio to write one: you can edit and preview Markdown in the IDE.

1. Add the README to your solution

A README at the repository root is usually not part of any project, so it doesn't show up in Solution Explorer. Add it as a solution item:

1. Right-click the solution in Solution Explorer.
2. Choose Add › Existing Item… (or New Item… if it doesn't exist yet).
3. Select README.md. It appears under a Solution Items folder.

With SDK-style projects, any README.md inside the project folder is picked up automatically.

2. Edit with live preview

Since Visual Studio 2022 version 17.5, a Markdown editor is built in. Open any .md file and you get:

• A live preview, side by side or top and bottom, which you can switch from the editor toolbar.
• Toolbar buttons for bold, italic, headings, lists, links and code.
• Syntax highlighting for fenced code blocks.

3. Markdown cheat sheet

4. A README template to start from

# My.Library

Short description of what it does and why.

## Install
    dotnet add package My.Library

## Usage
```csharp
var client = new MyClient(options);
var result = await client.RunAsync();
```

## License
MIT

5. Bonus: ship the README inside your NuGet package

nuget.org shows a package's README on its page. Include it from the .csproj:

<PropertyGroup>
  <PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup>
  <None Include="README.md" Pack="true" PackagePath="\" />
</ItemGroup>

Run dotnet pack, and the README is in the package and shows on nuget.org.