diff options
| author | Richard Lander <rlander@microsoft.com> | 2015-06-01 21:33:41 -0700 |
|---|---|---|
| committer | Richard Lander <rlander@microsoft.com> | 2015-06-01 21:40:54 -0700 |
| commit | 01cf43dfe666aa09b430ce72762e71e6da5f23e4 (patch) | |
| tree | d4e33890382aecdefd5c30bbce1a4365a5ce45c9 /Documentation/README.md | |
| parent | 2ff687cd797c2d7304673ebcf4c7f630eefbcd81 (diff) | |
| download | coreclr-01cf43dfe666aa09b430ce72762e71e6da5f23e4.tar.gz coreclr-01cf43dfe666aa09b430ce72762e71e6da5f23e4.tar.bz2 coreclr-01cf43dfe666aa09b430ce72762e71e6da5f23e4.zip | |
Re-work wiki as Repo docs
Diffstat (limited to 'Documentation/README.md')
| -rw-r--r-- | Documentation/README.md | 42 |
1 files changed, 29 insertions, 13 deletions
diff --git a/Documentation/README.md b/Documentation/README.md index e31fd87c24..2e7a1c1737 100644 --- a/Documentation/README.md +++ b/Documentation/README.md @@ -3,6 +3,12 @@ Documents Index This repo includes several documents that explain both high-level and low-level concepts about the .NET runtime. These are very useful for contributors, to get context that can be very difficult to acquire from just reading code. +Learn about .NET Core +==================== + +- [Brief Intro to .NET Core](dotnetcore-intro.md) +- [[WIP] Official .NET Core Docs](http://dotnet.readthedocs.org) + Get .NET Core ============= @@ -11,6 +17,23 @@ Get .NET Core - [Get .NET Core DNX SDK on Linux](get-dotnetcore-dnx-linux.md) - [Get .NET Core (Raw) on Windows](get-dotnetcore-windows.md) +Project Docs +============ + +- [Developer Guide](developer-guide.md) +- [Project priorities](project-priorities.md) +- [Contributing to .NET Core](contributing.md) +- [Contributing Workflow](contributing-workflow.md) +- [Performance Guidelines](performance-guidelines.md) +- [Garbage Collector Guidelines](garbage-collector-guidelines.md) + +Coding Guidelines +================= + +- [CLR Coding Guide](clr-code-guide.md) +- [CLR JIT Coding Conventions](clr_jit_coding_conventions.md) +- [Cross Platform Performance and Eventing Design](cross-platform-performance-and-eventing.md) + Build CoreCLR from Source ========================= @@ -18,8 +41,9 @@ Build CoreCLR from Source - [Building CoreCLR on Linux](linux-instructions.md) - [Building CoreCLR on OS X](osx-instructions.md) - [Building CoreCLR on Windows](windows-instructions.md) -- [Debugging CoreCLR](debugging-instructions.md) -- [Testing CoreCLR Changes](test-instructions.md) +- [Debugging CoreCLR on Windows](windows-debugging-instructions.md) +- [Testing Changes on Windows](windows-test-instructions.md) +- [Testing with CoreFX](testing-with-corefx.md) - [Creating a Custom DNX](custom-dnx-instructions.md) Book of the Runtime @@ -41,17 +65,6 @@ Book of the Runtime - [Implementing Profilability](profilability.md) - [What Every Dev needs to Know About Exceptions in the Runtime](exceptions.md) -.NET Runtime Specs -================== - -- [CLR Coding Guide](clr-code-guide.md) -- [.NET Standards (Ecma)](dotnet-standards.md) -- [Cross Platform Performance and Eventing Design](cross-platform-performance-and-eventing.md) - -RyuJIT Specs -============= -- [CLR JIT Coding Conventions](CLR_JIT_Coding_Conventions.md) - Decoder Rings ============= @@ -61,6 +74,9 @@ Decoder Rings Other Information ================= +- [CoreFX Repo documentation](https://github.com/dotnet/corefx/tree/master/Documentation) +- [Porting to .NET Core](https://github.com/dotnet/corefx/blob/master/Documentation/support-dotnet-core-instructions.md) +- [.NET Standards (Ecma)](dotnet-standards.md) - [CLR Configuration Knobs](clr-configuration-knobs.md) - [MSDN Entry for the CLR](http://msdn.microsoft.com/library/8bs2ecf4.aspx) - [Wikipedia Entry for the CLR](http://en.wikipedia.org/wiki/Common_Language_Runtime) |