Skip to content
This repository was archived by the owner on Dec 12, 2020. It is now read-only.

Commit 1c57ad4

Browse files
committed
docs: Add NuGet package list to Readme
Also add a note that metapackage is not for P2P references (same solution).
1 parent 48d5c6e commit 1c57ad4

File tree

2 files changed

+31
-3
lines changed

2 files changed

+31
-3
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
[![Build Status](https://andrewarnott.visualstudio.com/OSS/_apis/build/status/CodeGeneration.Roslyn)](https://andrewarnott.visualstudio.com/OSS/_build/latest?definitionId=15)
44
[![GitHub Actions CI status](https://github.com/AArnott/CodeGeneration.Roslyn/workflows/CI/badge.svg?branch=master)](https://github.com/AArnott/CodeGeneration.Roslyn/actions?query=workflow%3ACI+branch%3Amaster)
5-
[![NuGet package](https://img.shields.io/nuget/v/CodeGeneration.Roslyn.svg)][NuPkg]
65

76
Assists in performing Roslyn-based code generation during a build.
87
This includes design-time support, such that code generation can respond to
@@ -13,9 +12,31 @@ See [who's generating code or consuming it using CodeGeneration.Roslyn](https://
1312

1413
Instructions on development and using this project's source code are in [CONTRIBUTING.md](CONTRIBUTING.md).
1514

15+
## Packages
16+
17+
Package | Latest | Preview | Description
18+
---------|--------|---------|-------------
19+
| [CodeGeneration.Roslyn.Tool][CgrToolPkg] | ![NuGet package](https://img.shields.io/nuget/v/CodeGeneration.Roslyn.Tool) | ![NuGet preview package](https://img.shields.io/nuget/vpre/CodeGeneration.Roslyn.Tool) | Tool that loads Plugins and MSBuild targets that run it during build. |
20+
| [CodeGeneration.Roslyn.Templates][CgrTmpltPkg] | ![NuGet package](https://img.shields.io/nuget/v/CodeGeneration.Roslyn.Templates) | ![NuGet preview package](https://img.shields.io/nuget/vpre/CodeGeneration.Roslyn.Templates) | Templates for `dotnet new` that help create Plugins items and projects. |
21+
| [CodeGeneration.Roslyn][CgrPkg] | ![NuGet package](https://img.shields.io/nuget/v/CodeGeneration.Roslyn) | ![NuGet preview package](https://img.shields.io/nuget/vpre/CodeGeneration.Roslyn) | API for generators to build against. |
22+
| [CodeGeneration.Roslyn.Attributes][CgrAttrPkg] | ![NuGet package](https://img.shields.io/nuget/v/CodeGeneration.Roslyn.Attributes) | ![NuGet preview package](https://img.shields.io/nuget/vpre/CodeGeneration.Roslyn.Attributes) | Attributes to annotate plugin attributes with. |
23+
| [CodeGeneration.Roslyn.Engine][CgrEnginePkg] | ![NuGet package](https://img.shields.io/nuget/v/CodeGeneration.Roslyn.Engine) | ![NuGet preview package](https://img.shields.io/nuget/vpre/CodeGeneration.Roslyn.Engine) | Engine called by Tool; useful for testing generators. |
24+
| [CodeGeneration.Roslyn.Plugin.Sdk][CgrPluginSdkPkg] | ![NuGet package](https://img.shields.io/nuget/v/CodeGeneration.Roslyn.Plugin.Sdk) | ![NuGet preview package](https://img.shields.io/nuget/vpre/CodeGeneration.Roslyn.Plugin.Sdk) | [MSBuild project Sdk] that facilitates correct Plugin project setup. |
25+
| [CodeGeneration.Roslyn.PluginMetapackage.Sdk][CgrPluginMetaSdkPkg] | ![NuGet package](https://img.shields.io/nuget/v/CodeGeneration.Roslyn.PluginMetapackage.Sdk) | ![NuGet preview package](https://img.shields.io/nuget/vpre/CodeGeneration.Roslyn.PluginMetapackage.Sdk) | [MSBuild project Sdk] that facilitates correct [Plugin metapackage](#create-the-metapackage) project setup. |
26+
27+
28+
[CgrToolPkg]: https://www.nuget.org/packages/CodeGeneration.Roslyn.Tool
29+
[CgrTmpltPkg]: https://www.nuget.org/packages/CodeGeneration.Roslyn.Templates
30+
[CgrPkg]: https://www.nuget.org/packages/CodeGeneration.Roslyn
31+
[CgrAttrPkg]: https://www.nuget.org/packages/CodeGeneration.Roslyn.Attributes
32+
[CgrEnginePkg]: https://www.nuget.org/packages/CodeGeneration.Roslyn.Engine
33+
[CgrPluginSdkPkg]: https://www.nuget.org/packages/CodeGeneration.Roslyn.Plugin.Sdk
34+
[CgrPluginMetaSdkPkg]: https://www.nuget.org/packages/CodeGeneration.Roslyn.PluginMetapackage.Sdk
35+
1636
## Table of Contents
1737

1838
- [Roslyn-based Code Generation](#roslyn-based-code-generation)
39+
- [Packages](#packages)
1940
- [Table of Contents](#table-of-contents)
2041
- [How to write your own code generator](#how-to-write-your-own-code-generator)
2142
- [Prerequisites](#prerequisites)
@@ -508,7 +529,10 @@ consumers will need:
508529
Our metapackage should be versioned in the same manner
509530
as it's dependant packages.
510531

511-
> 📋 For a sample metapackage, see [MetapackageSample](samples/MetapackageSample/).
532+
> ⚠ Please note that Metapackage project doesn't change how P2P (`ProjectReference`)
533+
> setup works - it **only** works as a NuGet package!
534+
535+
> ℹ For a sample metapackage, see [MetapackageSample](samples/MetapackageSample/).
512536
513537

514538
#### Add extra `build/` content in Plugin package

samples/MetapackageSample/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,8 @@ Important aspects of the `Metapackage/Metapackage.csproj`:
2323
* variables used (`$(PackageVersion)`, `$(LocalNuGetVersion)`) should be replaced
2424
with whatever you use in your setup. `LocalNuGetVersion` is the version of CG.R
2525
used across samples - you should use the same version as other CG.R packages you
26-
reference. `Directory.Build.props` is a good place to define that once.
26+
reference. `Directory.Build.props` is a good place to define that once.
27+
28+
29+
> ⚠ Please note that Metapackage project doesn't change how P2P (`ProjectReference`)
30+
> setup works - it **only** works as a NuGet package!

0 commit comments

Comments
 (0)