-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from stephentoub/new_readme
Initial port and addition of README.md
- Loading branch information
Showing
1 changed file
with
72 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| ## Welcome to the .NET Compiler Platform ("Roslyn") | ||
|
|
||
| The .NET Compiler Platform ("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. | ||
|
|
||
| ### Try new language and IDE features | ||
|
|
||
| Just want to provide feedback on new [language features](https://roslyn.codeplex.com/wikipage?title=Language%20feature%20status&referringTitle=Home) | ||
| and [IDE features](http://blogs.msdn.com/b/visualstudio/archive/2014/11/12/the-c-and-visual-basic-code-focused-ide-experience.aspx)? | ||
|
|
||
| * Try out [Visual Studio 2015 Preview](http://www.visualstudio.com/en-us/downloads/visual-studio-2015-downloads-vs), | ||
| which has the latest features built-in. | ||
|
|
||
| Want to keep your box clean? You can use | ||
| [prebuilt Azure VM images](http://blogs.msdn.com/b/visualstudioalm/archive/2014/06/04/visual-studio-14-ctp-now-available-in-the-virtual-machine-azure-gallery.aspx) | ||
| with VS 2015 Preview already installed. | ||
|
|
||
| * You can also try April's [End User Preview](http://go.microsoft.com/fwlink/?LinkId=394641), | ||
| which installs on top of Visual Studio 2013. *(Note: The VS 2013 preview is quite out of date, and is no longer being updated.)* | ||
|
|
||
| ### Build tools that understand C# and Visual Basic | ||
|
|
||
| Get started building diagnostics, code fixes, refactorings, and other code-aware tools! | ||
|
|
||
| 1. Set up a box with Visual Studio 2015 Preview. Either | ||
| [install Visual Studio 2015 Preview](http://www.visualstudio.com/en-us/downloads/visual-studio-2015-downloads-vs), | ||
| or grab a [prebuilt Azure VM image](http://blogs.msdn.com/b/visualstudioalm/archive/2014/06/04/visual-studio-14-ctp-now-available-in-the-virtual-machine-azure-gallery.aspx). | ||
| 2. Install the [Visual Studio 2015 Preview SDK](http://www.visualstudio.com/en-us/downloads/visual-studio-2015-downloads-vs). | ||
| You'll need to do this even if you're using the Azure VM image. | ||
| 3. Install the [SDK Templates VSIX package](http://visualstudiogallery.msdn.microsoft.com/849f3ab1-05cf-4682-b4af-ef995e2aa1a5) | ||
| to get the Visual Studio project templates. | ||
| 4. Install the [Syntax Visualizer VSIX package](http://visualstudiogallery.msdn.microsoft.com/70e184da-9b3a-402f-b210-d62a898e2887) | ||
| to get a [Syntax Visualizer tool window](https://roslyn.codeplex.com/wikipage?title=Syntax%20Visualizer&referringTitle=Home) | ||
| to help explore the syntax trees you'll be analyzing. | ||
|
|
||
| Or, you can grab the latest [NuGet Roslyn compiler package](http://www.nuget.org/packages/Microsoft.CodeAnalysis). | ||
| From the NuGet package manager console: | ||
|
|
||
| Install-Package Microsoft.CodeAnalysis -Pre | ||
|
|
||
| ### Source code | ||
|
|
||
| * Clone the sources: `git clone https://github.com/dotnet/roslyn.git` | ||
| * [Enhanced source view](http://source.roslyn.codeplex.com/), powered by Roslyn | ||
| * [Building, testing and debugging the sources](https://roslyn.codeplex.com/wikipage?title=Building%2c%20Testing%20and%20Debugging&referringTitle=Home) | ||
|
|
||
| ### Get started | ||
|
|
||
| * [Roslyn Overview](https://roslyn.codeplex.com/wikipage?title=Overview&referringTitle=Home) | ||
| * [Samples and Walkthroughs](https://roslyn.codeplex.com/wikipage?title=Samples%20and%20Walkthroughs&referringTitle=Home) | ||
| * [Syntax Visualizer Tool](https://roslyn.codeplex.com/wikipage?title=Syntax%20Visualizer&referringTitle=Home) | ||
| * [Roadmap](https://roslyn.codeplex.com/wikipage?title=Roadmap&referringTitle=Home) | ||
| * [Language Feature Status](https://roslyn.codeplex.com/wikipage?title=Language%20Feature%20Status&referringTitle=Home) | ||
| * [Language Design Notes](https://roslyn.codeplex.com/documentation?referringTitle=Home&ANCHOR#langdesignlinks) | ||
| * [FAQ](https://roslyn.codeplex.com/wikipage?title=FAQ&referringTitle=Home) | ||
|
|
||
| ### Contribute! | ||
|
|
||
| Some of the best ways to contribute are to try things out, file bugs, and join in design conversations. | ||
|
|
||
| * [Questions, Comments, and Feedback](https://roslyn.codeplex.com/wikipage?title=Questions%2c%20Comments%2c%20and%20Feedback&referringTitle=Home) | ||
|
|
||
| Looking for something to work on? The list of [up-for-grabs issues](https://roslyn.codeplex.com/workitem/list/advanced?keyword=grabs&status=Open%2b%28not%2bclosed%29&type=All&priority=All&release=All&assignedTo=All&component=All&reasonClosed=All&sortField=LastUpdatedDate&sortDirection=Descending&page=0) is a great place to start. | ||
|
|
||
| * [How to Contribute](https://roslyn.codeplex.com/wikipage?title=How%20to%20Contribute&referringTitle=Home) | ||
| * [Pull requests](https://github.com/dotnet/roslyn/pulls) | ||
|
|
||
| ### .NET Foundation | ||
|
|
||
| This project is part of the [.NET Foundation](http://www.dotnetfoundation.org/projects) along with other | ||
| projects like [the class libraries for .NET Core](https://github.com/dotnet/corefx/). |