Skip to content

Commit 99a6370

Browse files
author
msftbot[bot]
authored
Merge pull request #51600 from dotnet/dev/mikadumont/update-readme
Update Readme
2 parents 33608c5 + d106c3a commit 99a6370

File tree

1 file changed

+22
-39
lines changed

1 file changed

+22
-39
lines changed

README.md

+22-39
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1-
## Welcome to the .NET Compiler Platform ("Roslyn")
1+
<p align="center">
2+
<img width="450" src="https://user-images.githubusercontent.com/46729679/109719841-17b7dd00-7b5e-11eb-8f5e-87eb2d4d1be9.png" alt="Roslyn logo">
3+
</p>
24

3-
[![Join the chat at https://gitter.im/dotnet/roslyn](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dotnet/roslyn?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Chat on Discord](https://discordapp.com/api/guilds/143867839282020352/widget.png)](http://aka.ms/discord-csharp-roslyn)
5+
<h1 align="center">The .NET Compiler Platform</h1>
46

5-
Roslyn provides open-source C# and Visual Basic compilers with rich code analysis APIs. It enables building code analysis tools with the same APIs that are used by Visual Studio.
7+
<p align="center"><a href="https://gitter.im/dotnet/roslyn?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge&amp;utm_content=badge" rel="nofollow"><img src="https://camo.githubusercontent.com/5dbac0213da25c445bd11f168587c11a200ba153ef3014e8408e462e410169b3/68747470733a2f2f6261646765732e6769747465722e696d2f4a6f696e253230436861742e737667" alt="Join the chat at https://gitter.im/dotnet/roslyn" data-canonical-src="https://badges.gitter.im/Join%20Chat.svg" style="max-width:100%;"></a> <a href="http://aka.ms/discord-csharp-roslyn" rel="nofollow"><img src="https://camo.githubusercontent.com/1ea6a95121cbf4179d411e853681838825392a7f0ae7e6bb1e03f4ea37c8fd5d/68747470733a2f2f646973636f72646170702e636f6d2f6170692f6775696c64732f3134333836373833393238323032303335322f7769646765742e706e67" alt="Chat on Discord" data-canonical-src="https://discordapp.com/api/guilds/143867839282020352/widget.png" style="max-width:100%;"></a></p>
8+
9+
Roslyn is the open-source implementation of both the C# and Visual Basic compilers with an API surface for building code analysis tools.
610

711
### C# and Visual Basic Language Feature Suggestions
812

@@ -11,50 +15,31 @@ If you want to suggest a new feature for the C# or Visual Basic languages go her
1115
- [dotnet/vblang](https://github.com/dotnet/vblang) for VB-specific features
1216
- [dotnet/csharplang](https://github.com/dotnet/csharplang) for features that affect both languages
1317

14-
## Contribute!
18+
### Contributing
1519

16-
Some of the best ways to contribute are to try things out, file bugs, and join in design conversations.
20+
All work on the C# and Visual Basic compiler happens directly on [GitHub](https://github.com/dotnet/roslyn). Both core team members and external contributors send pull requests which go through the same review process.
1721

18-
### Questions
22+
If you are interested in fixing issues and contributing directly to the code base, a great way to get started is to ask some questions on [GitHub Discussions](https://github.com/dotnet/roslyn/discussions)! Then check out our [contributing guide](https://github.com/dotnet/roslyn/blob/master/docs/contributing/Building%2C%20Debugging%2C%20and%20Testing%20on%20Windows.md) which covers the following:
1923

20-
A great way to get started is to ask some questions!
21-
- Start with a question on [discussions](https://github.com/dotnet/roslyn/discussions)
22-
- You can also join in on the design discussions on [gitter](https://gitter.im/dotnet/roslyn) or [discord](http://aka.ms/discord-csharp-roslyn)
24+
- [Coding guidelines](https://github.com/dotnet/roslyn/blob/master/docs/wiki/Contributing-Code.md)
25+
- [The development workflow, including debugging and running tests](https://github.com/dotnet/roslyn/blob/master/docs/contributing/Building%2C%20Debugging%2C%20and%20Testing%20on%20Windows.md)
26+
- [Submitting pull requests](https://github.com/dotnet/roslyn/blob/master/CONTRIBUTING.md)
27+
- Finding a bug to fix in the [IDE](https://aka.ms/roslyn-ide-bugs-help-wanted) or [Compiler](https://aka.ms/roslyn-compiler-bugs-help-wanted)
28+
- Finding a feature to implement in the [IDE](https://aka.ms/roslyn-ide-feature-help-wanted) or [Compiler](https://aka.ms/roslyn-compiler-feature-help-wanted)
2329

24-
### See if your issue is already being worked on! (Add your own votes using the 👍 reaction)
25-
- [IDE](https://aka.ms/roslyn-ide-in-progress)
26-
- [Compiler](https://aka.ms/roslyn-compiler-in-progress)
30+
### Community
2731

28-
### Vote in the Backlog! (Add your own votes using the 👍 reaction)
29-
- [IDE Bugs](https://aka.ms/roslyn-ide-bug-backlog)
30-
- [IDE Features](https://aka.ms/roslyn-ide-feature-backlog)
31-
- [Compiler Bugs](https://aka.ms/roslyn-compiler-bug-backlog)
32-
- [Compiler Features](https://aka.ms/roslyn-compiler-features-backlog)
32+
The Roslyn community can be found on [GitHub Discussions](https://github.com/dotnet/roslyn/discussions), where you can ask questions, voice ideas, and share your projects.
3333

34-
### Find a bug to fix! (Add your own votes using the 👍 reaction)
35-
- First read this guide: [How to Contribute](docs/wiki/Contributing-Code.md)
36-
- [Building, testing and debugging the sources](docs/wiki/Building-Testing-and-Debugging.md)
37-
- Top Bugs
38-
- [IDE](https://aka.ms/roslyn-ide-bugs-help-wanted)
39-
- [Compiler](https://aka.ms/roslyn-compiler-bugs-help-wanted)
34+
To chat with other community members, you can join the Roslyn [Discord](https://discord.com/invite/tGJvv88) or [Gitter](https://gitter.im/dotnet/roslyn).
4035

41-
### Find a feature to implement! (Add your own votes using the 👍 reaction)
42-
- [IDE](https://aka.ms/roslyn-ide-feature-help-wanted)
43-
- [Compiler](https://aka.ms/roslyn-compiler-feature-help-wanted)
36+
Our [Code of Conduct](CODE-OF-CONDUCT.md) applies to all Roslyn community channels and has adopted the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
4437

38+
### Documentation
4539

46-
### Getting started with the Roslyn APIs
40+
Visit [Roslyn Architecture Overview](https://docs.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/compiler-api-model) to get started with Roslyn’s API’s.
4741

48-
If you want to get started using Roslyn's APIs to analyzer your code take a look at these links:
49-
- [Roslyn Architecture Overview](https://docs.microsoft.com/dotnet/csharp/roslyn-sdk/compiler-api-model)
50-
- [Syntax APIs](https://docs.microsoft.com/dotnet/csharp/roslyn-sdk/work-with-syntax)
51-
- [Semantic APIs](https://docs.microsoft.com/dotnet/csharp/roslyn-sdk/work-with-semantics)
52-
- [Workspace APIs](https://docs.microsoft.com/dotnet/csharp/roslyn-sdk/work-with-workspace)
53-
- [Tutorial: Write your first analyzer and code fix](https://docs.microsoft.com/dotnet/csharp/roslyn-sdk/tutorials/how-to-write-csharp-analyzer-code-fix)
54-
- Useful Tools
55-
- [Syntax Visualizer Tool](https://docs.microsoft.com/dotnet/csharp/roslyn-sdk/syntax-visualizer)
56-
- [Syntax Quoter Tool](http://roslynquoter.azurewebsites.net)
57-
- Browse the source with the [enhanced source view](http://sourceroslyn.io/)
42+
### NuGet Feeds
5843

5944
**The latest pre-release builds** are available from the following public NuGet feeds:
6045
- [Compiler](https://dev.azure.com/dnceng/public/_packaging?_a=feed&feed=dotnet-tools): `https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json`
@@ -102,8 +87,6 @@ If you want to get started using Roslyn's APIs to analyzer your code take a look
10287

10388
[//]: # (End current test results)
10489

105-
This [project](CODE-OF-CONDUCT.md) has adopted the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
106-
10790
### .NET Foundation
10891

10992
This project is part of the [.NET Foundation](http://www.dotnetfoundation.org/projects) along with other

0 commit comments

Comments
 (0)