Skip to content

Commit ce5a312

Browse files
committed
Revise README.md
1 parent adbda6f commit ce5a312

1 file changed

Lines changed: 17 additions & 2 deletions

File tree

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,17 @@
1-
# CompilerPlatform
2-
"Riverside.CompilerPlatform" provides extensions to Roslyn that make building source generators simple.
1+
# `Riverside.CompilerPlatform`
2+
3+
`Riverside.CompilerPlatform` provides extensions to Roslyn that make building code analysis tools simple.
4+
5+
---
6+
7+
You can build powerful source generators, analyzers, and code fixers using the tools provided by the `Riverside.CompilerPlatform` library.
8+
It provides a simple abstraction over Roslyn's powerful yet often overwhelming APIs and makes the creation of code analysis tools simple and straight-forward while still having the full potential and capability of a regular code analysis tool that invokes the Roslyn APIs directly.
9+
10+
`Riverside.CompilerPlatform` is comprised of three main libraries:
11+
12+
- `Riverside.CompilerPlatform.Analyzers`: Exposes helpers and classes for building diagnostic analyzers
13+
- `Riverside.CompilerPlatform.CodeFixers`: Exposes abstract classes for building functional code fixes
14+
- `Riverside.CompilerPlatform.HighPerformance`: Exposes static helpers for making fast and efficient code analysis tools
15+
- `Riverside.CompilerPlatform.SourceGenerators`: Exposes abstract classes to inherit from for building source generator tools
16+
17+
All of these libraries contain extensions to their respective code analysis tool types, and enable the building of efficient and advanced source generators via the abstractions they expose.

0 commit comments

Comments
 (0)