Documentation

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.

Intro to .NET Core

.NET Core is a self-contained .NET runtime and framework that implements ECMA 335. It can be (and has been) ported to multiple architectures and platforms. It support a variety of installation options, having no specific deployment requirements itself.

Learn about .NET Core

• [WIP] Official .NET Core Docs

Get .NET Core

• Get .NET Core DNX SDK on Windows
• Get .NET Core DNX SDK on OS X
• Get .NET Core DNX SDK on Linux
• Get .NET Core (Raw) on Windows

Project Docs

• Developer Guide
• Project priorities
• Contributing to .NET Core
• Contributing Workflow
• Performance Guidelines
• Garbage Collector Guidelines
• Adding new public APIs to mscorlib

Coding Guidelines

• CLR Coding Guide
• CLR JIT Coding Conventions
• Cross Platform Performance and Eventing Design

Build CoreCLR from Source

• Building CoreCLR on FreeBSD
• Building CoreCLR on Linux
• Building CoreCLR on OS X
• Building CoreCLR on Windows
• Debugging CoreCLR on Windows
• Testing Changes on Windows
• Testing Changes on Linux, OS X, and FreeBSD
• Testing with CoreFX
• Creating a Custom DNX

Book of the Runtime

• Book of the Runtime FAQ
• Introduction to the Common Language Runtime
• Garbage Collection Design
• Threading
• RyuJIT Overview
• Type System
• Type Loader
• Method Descriptor
• Virtual Stub Dispatch
• Stack Walking
• Mscorlib and Calling Into the Runtime
• Data Access Component (DAC) Notes
• Profiling
• Implementing Profilability
• What Every Dev needs to Know About Exceptions in the Runtime
• ReadyToRun Overview

Decoder Rings

• .NET Core Glossary
• .NET Filename Encyclopedia

Other Information

• CoreFX Repo documentation
• Porting to .NET Core
• .NET Standards (Ecma)
• CLR Configuration Knobs
• MSDN Entry for the CLR
• Wikipedia Entry for the CLR