Update README (#728)
* Update README * Update README links * Update per feedback * Add link to .NET platform
This commit is contained in:
Rich Lander
GitHub
parent
3f76e518ea
commit
813a270b28
30
Documentation/core-repos.md
Normal file
30
Documentation/core-repos.md
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
# .NET Core Repos
|
||||
|
||||
There are many repos that make up .NET Core. To file an issue, make a PR, or engage on specific topics, it is best to engage with developers working on the right repo. A largely complete set .NET Core repositories follows.
|
||||
|
||||
## .NET Core
|
||||
|
||||
* [dotnet/cli](https://github.com/dotnet/cli) - .NET Core CLI tools
|
||||
* [dotnet/corefx](https://github.com/dotnet/corefx) - .NET Core framework APIs
|
||||
* [dotnet/coreclr](https://github.com/dotnet/coreclr) - .NET Core runtime
|
||||
* [dotnet/docs](https://github.com/dotnet/docs) - .NET documentation
|
||||
* [dotnet/sdk](https://github.com/dotnet/sdk) - .NET Core SDK (used by Visual Studio and CLI)
|
||||
|
||||
## .NET Standard
|
||||
|
||||
* [dotnet/standard](https://github.com/dotnet/standard) - .NET Standard definition
|
||||
|
||||
## Languages
|
||||
|
||||
* [dotnet/roslyn](https://github.com/dotnet/roslyn) - Roslyn and C#
|
||||
* [dotnet/csharplang](https://github.com/dotnet/csharplang)
|
||||
* [dotnet/netcorecli-fsc](https://github.com/dotnet/netcorecli-fsc) - F# integration into .NET CLI
|
||||
|
||||
## NuGet
|
||||
|
||||
* [nuget/home](https://github.com/nuget/home) - NuGet client
|
||||
|
||||
## ASP.NET Core
|
||||
|
||||
* [aspnet/home](https://github.com/aspnet/home) - ASP.NET Core framework
|
||||
* [aspnet/Docs](https://github.com/aspnet/Docs) - ASP.NET and ASP.NET Core documentation
|
||||
101
README.md
101
README.md
|
|
@ -1,67 +1,42 @@
|
|||
# .NET Core Home
|
||||
|
||||
The core repository is the starting point to engage in and learn about the
|
||||
.NET Core stack.
|
||||
|
||||
> **Note:** please note that this repository is not for filing product issues.
|
||||
> If you run into an issue using .NET Core, there are multiple repos where you can
|
||||
> file an issue:
|
||||
> * [dotnet/cli](https://github.com/dotnet/cli) - for CLI tools and questions
|
||||
> * [dotnet/corefx](https://github.com/dotnet/corefx) - for API issues and questions
|
||||
> * [dotnet/coreclr](https://github.com/dotnet/coreclr) - for runtime issues
|
||||
> * [dotnet/docs](https://github.com/dotnet/docs) - for .NET documentation issues and questions
|
||||
> * [dotnet/sdk](https://github.com/dotnet/sdk) - for .NET Core SDK (used by Visual Studio and CLI) issues and questions
|
||||
> * [dotnet/standard](https://github.com/dotnet/standard) - for .NET Standard issues and questions
|
||||
> * [nuget/home](https://github.com/nuget/home) - for NuGet questions and issues
|
||||
> * [aspnet/home](https://github.com/aspnet/home) - for ASP.NET Core questions and issues.
|
||||
> * [aspnet/Docs](https://github.com/aspnet/Docs) - for ASP.NET and ASP.NET Core documentation issues and questions
|
||||
> * [dotnet/netcorecli-fsc](https://github.com/dotnet/netcorecli-fsc) - for F# questions and issues
|
||||
|
||||
>
|
||||
> We will be removing the ability to file issues on this repo in the near future.
|
||||
The dotnet/core repository is a good starting point for .NET Core.
|
||||
|
||||
## Get Started
|
||||
|
||||
If you're new to .NET Core and have 10 minutes to try it, start here:
|
||||
- [What is .NET Core?](https://www.microsoft.com/net/core/platform)
|
||||
- [Get Started with the Official releases of .NET Core on Windows, OSX and Linux](https://www.microsoft.com/net/core)
|
||||
If you're new to .NET Core, you can get started in 10 minutes:
|
||||
|
||||
If you have some more time and want to go deeper or get the latest builds:
|
||||
- [Get the latest builds of .NET Core on Windows, OSX and Linux](https://github.com/dotnet/core-setup/blob/master/README.md)
|
||||
- [Get the latest builds of ASP.NET Core on Windows, OSX and Linux](https://github.com/aspnet/home)
|
||||
- [Get started with .NET Core](https://www.microsoft.com/net/core)
|
||||
- [Download .NET Core](https://github.com/dotnet/core/blob/master/release-notes/download-archive.md)
|
||||
|
||||
## .NET Core Platform
|
||||
## Learn about .NET Core
|
||||
|
||||
The .NET Core platform is made of several components, which includes the
|
||||
managed compilers, the runtime, the base class libraries, and numerous application models such as
|
||||
ASP.NET.
|
||||
- [Learn about .NET Core]
|
||||
(https://docs.microsoft.com/dotnet/core)
|
||||
- [.NET Core Roadmap](https://github.com/dotnet/core/blob/master/roadmap.md)
|
||||
- [.NET Core release notes](https://github.com/dotnet/core/blob/master/release-notes/README.md)
|
||||
- [Learn how about the .NET platform](https://docs.microsoft.com/dotnet/standard/)
|
||||
|
||||
* [Roadmap](roadmap.md)
|
||||
* [.NET Core Framework](https://github.com/dotnet/corefx)
|
||||
* [.NET Core Runtime](https://github.com/dotnet/coreclr)
|
||||
* [.NET Compiler Platform ("Roslyn")](https://github.com/dotnet/roslyn)
|
||||
* [ASP.NET Core](https://github.com/aspnet/home)
|
||||
## Getting help
|
||||
|
||||
- [File a general .NET Core issue](https://github.com/dotnet/core/issues)
|
||||
- [File a more specific issue](Documentation/core-repos.md)
|
||||
- [Ask on StackOverflow](https://stackoverflow.com/questions/ask)
|
||||
- [Contact Microsoft Support](https://support.microsoft.com/contactus/)
|
||||
|
||||
## How to Engage, Contribute and Provide Feedback
|
||||
|
||||
All projects accept contributions:
|
||||
The .NET Core team encourages [contributions](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/contributing.md), both issues and PRs. The first step is finding the [.NET Core repository](Documentation/core-repos.md) that you want to contribute to.
|
||||
|
||||
* [.NET Core Contributing Guide](https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/contributing.md)
|
||||
* [.NET Compiler Platform ("Roslyn")](https://github.com/dotnet/roslyn/wiki/Contributing-Code)
|
||||
* [ASP.NET Contributing Guide](https://github.com/aspnet/Home/blob/master/CONTRIBUTING.md)
|
||||
## Download .NET Core
|
||||
|
||||
You are also encouraged to start a discussion by posting on the
|
||||
[.NET Foundation Forums](http://forums.dotnetfoundation.org/) or filing an
|
||||
issue in the corresponding GitHub project. See the contributing guides for more
|
||||
details.
|
||||
- [Released builds](https://github.com/dotnet/core/blob/master/release-notes/download-archive.md)
|
||||
- [_latest_ .NET Core SDK](https://github.com/dotnet/cli/blob/master/README.md#installers-and-binaries)
|
||||
- [_latest_ .NET Core Runtime](https://github.com/dotnet/core-setup/blob/master/README.md#daily-builds)
|
||||
|
||||
## .NET Foundation
|
||||
|
||||
The .NET Core platform is part of the [.NET Foundation](http://www.dotnetfoundation.org/projects).
|
||||
|
||||
* [.NET Core Project](http://www.dotnetfoundation.org/net-core)
|
||||
* [.NET Compiler Platform ("Roslyn" Project)](http://www.dotnetfoundation.org/net-compiler-platform-roslyn)
|
||||
* [ASP.NET Core Project](http://www.dotnetfoundation.org/asp-net-core)
|
||||
The .NET Core platform is part of the [.NET Foundation](http://www.dotnetfoundation.org).
|
||||
|
||||
## Licenses
|
||||
|
||||
|
|
@ -71,35 +46,3 @@ Some projects license documentation and other forms of content under
|
|||
[Creative Commons Attribution 4.0](http://creativecommons.org/licenses/by/4.0/).
|
||||
|
||||
See specific projects to understand the license used.
|
||||
|
||||
## Understanding the relationship between .NET Core and the .NET Framework
|
||||
|
||||
.NET Core and the .NET Framework have (for the most part) a subset-superset
|
||||
relationship. .NET Core is named "Core" since it contains the core features from
|
||||
the .NET Framework, for both the runtime and framework libraries. For example,
|
||||
.NET Core and the .NET Framework share the GC, the JIT and types such as
|
||||
`String` and `List<T>`.
|
||||
|
||||
.NET Core was created so that .NET could be open source, cross platform and be
|
||||
used in more resource-constrained environments. We have also published a subset
|
||||
of the [.NET Reference Source](https://github.com/Microsoft/referencesource)
|
||||
under the MIT license, so that you and the community can port additional .NET
|
||||
Framework features to .NET Core.
|
||||
|
||||
## Understanding the relationship between .NET Core and Mono
|
||||
|
||||
Mono is an important part of the .NET ecosystem, particularly for client
|
||||
scenarios (for example, Xamarin). We will look for ways to collaborate with Mono
|
||||
developers and encourage them to take our code to improve Mono. We will also
|
||||
look for opportunities to improve .NET Core with MIT-licensed Mono code.
|
||||
|
||||
An important collaboration opportunity is making .NET Core NuGet packages
|
||||
(produced from this code) work on Mono. The SIMD NuGet package is a perfect
|
||||
example.
|
||||
|
||||
## Learning about ASP.NET and .NET Core
|
||||
|
||||
[ASP.NET Core](https://github.com/aspnet/home) is a new cross-platform version of
|
||||
ASP.NET that is designed for the cloud, and runs on Windows, Linux and Mac. It
|
||||
targets .NET Core by default, but you may choose to target the .NET Framework on
|
||||
Windows.
|
||||
|
|
|
|||
Loading…
Reference in a new issue