Documentation/README.md

   1 Documents Index
   2 ===============
   3
   4 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.
   5
   6 Intro to .NET Core
   7 ==================
   8
   9 .NET Core is a self-contained .NET runtime and framework that implements [ECMA 335](project-docs/dotnet-standards.md). It can be (and has been) ported to multiple architectures and platforms. It supports a variety of installation options, having no specific deployment requirements itself.
  10
  11 Learn about .NET Core
  12 ====================
  13
  14 - [[WIP] Official .NET Core Docs](http://dotnet.github.io/docs/)
  15
  16 Get .NET Core
  17 =============
  18
  19 - [Get .NET Core DNX SDK on Windows](install/get-dotnetcore-dnx-windows.md)
  20 - [Get .NET Core DNX SDK on OS X](install/get-dotnetcore-dnx-osx.md)
  21 - [Get .NET Core DNX SDK on Linux](install/get-dotnetcore-dnx-linux.md)
  22 - [Get .NET Core (Raw) on Windows](install/get-dotnetcore-windows.md)
  23
  24 Project Docs
  25 ============
  26
  27 - [Developer Guide](project-docs/developer-guide.md)
  28 - [Project priorities](project-docs/project-priorities.md)
  29 - [Contributing to .NET Core](project-docs/contributing.md)
  30 - [Contributing Workflow](project-docs/contributing-workflow.md)
  31 - [Performance Guidelines](project-docs/performance-guidelines.md)
  32 - [Garbage Collector Guidelines](project-docs/garbage-collector-guidelines.md)
  33 - [Adding new public APIs to mscorlib](project-docs/adding_new_public_apis.md)
  34 - [Project NuGet Dependencies](https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/project-nuget-dependencies.md)
  35
  36 Coding Guidelines
  37 =================
  38
  39 - [CLR Coding Guide](coding-guidelines/clr-code-guide.md)
  40 - [CLR JIT Coding Conventions](coding-guidelines/clr-jit-coding-conventions.md)
  41 - [Cross Platform Performance and Eventing Design](coding-guidelines/cross-platform-performance-and-eventing.md)
  42 - [Adding New Events to the VM](coding-guidelines/EventLogging.md)
  43
  44 Build CoreCLR from Source
  45 =========================
  46
  47 - [Building CoreCLR on FreeBSD](building/freebsd-instructions.md)
  48 - [Building CoreCLR on Linux](building/linux-instructions.md)
  49 - [Building CoreCLR on OS X](building/osx-instructions.md)
  50 - [Building CoreCLR on Windows](building/windows-instructions.md)
  51
  52 Testing and Debugging CoreCLR
  53 =============================
  54
  55 - [Debugging CoreCLR](building/debugging-instructions.md)
  56 - [Testing Changes on Windows](building/windows-test-instructions.md)
  57 - [Testing Changes on Linux, OS X, and FreeBSD](building/unix-test-instructions.md)
  58 - [Testing with CoreFX](building/testing-with-corefx.md)
  59 - [.NET Performance Data Collection Script](https://raw.githubusercontent.com/dotnet/corefx-tools/master/src/performance/perfcollect/perfcollect)
  60
  61 Book of the Runtime
  62 ===================
  63
  64 - [Book of the Runtime FAQ](botr/botr-faq.md)
  65 - [Introduction to the Common Language Runtime](botr/intro-to-clr.md)
  66 - [Garbage Collection Design](botr/garbage-collection.md)
  67 - [Threading](botr/threading.md)
  68 - [RyuJIT Overview](botr/ryujit-overview.md)
  69 - [Type System](botr/type-system.md)
  70 - [Type Loader](botr/type-loader.md)
  71 - [Method Descriptor](botr/method-descriptor.md)
  72 - [Virtual Stub Dispatch](botr/virtual-stub-dispatch.md)
  73 - [Stack Walking](botr/stackwalking.md)
  74 - [Mscorlib and Calling Into the Runtime](botr/mscorlib.md)
  75 - [Data Access Component (DAC) Notes](botr/dac-notes.md)
  76 - [Profiling](botr/profiling.md)
  77 - [Implementing Profilability](botr/profilability.md)
  78 - [What Every Dev needs to Know About Exceptions in the Runtime](botr/exceptions.md)
  79 - [ReadyToRun Overview](botr/readytorun-overview.md)
  80
  81 Decoder Rings
  82 =============
  83
  84 - [.NET Core Glossary](project-docs/glossary.md)
  85 - [.NET Filename Encyclopedia](project-docs/dotnet-filenames.md)
  86
  87 Other Information
  88 =================
  89
  90 - [CoreFX Repo documentation](https://github.com/dotnet/corefx/tree/master/Documentation)
  91 - [Porting to .NET Core](https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/support-dotnet-core-instructions.md)
  92 - [.NET Standards (Ecma)](project-docs/dotnet-standards.md)
  93 - [CLR Configuration Knobs](project-docs/clr-configuration-knobs.md)
  94 - [MSDN Entry for the CLR](http://msdn.microsoft.com/library/8bs2ecf4.aspx)
  95 - [Wikipedia Entry for the CLR](http://en.wikipedia.org/wiki/Common_Language_Runtime)