diff options
| author | Vance Morrison <vancem@microsoft.com> | 2016-08-04 14:00:10 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-08-04 14:00:10 -0700 |
| commit | 4974ff6a7deeadb46db3180a3c3efaa322757649 (patch) | |
| tree | b7e76de3879d9eaa171c39abe6ff100e90af33d3 /Documentation | |
| parent | 010f42a541f9d1e787774a538d9b923a506ea8f2 (diff) | |
| parent | 75cf5b733ababfac4476aa24d3f8293f7d4ea7a5 (diff) | |
| download | coreclr-4974ff6a7deeadb46db3180a3c3efaa322757649.tar.gz coreclr-4974ff6a7deeadb46db3180a3c3efaa322757649.tar.bz2 coreclr-4974ff6a7deeadb46db3180a3c3efaa322757649.zip | |
Merge pull request #6612 from vancem/Doc_Add_BOTR_TOC
Add a table of contents to the book of the runtime
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/README.md | 21 | ||||
| -rw-r--r-- | Documentation/botr/_tableOfContents.md | 30 |
2 files changed, 37 insertions, 14 deletions
diff --git a/Documentation/README.md b/Documentation/README.md index 70167e4bb4..481941ae62 100644 --- a/Documentation/README.md +++ b/Documentation/README.md @@ -56,23 +56,16 @@ Testing and Debugging CoreCLR Book of the Runtime =================== -- [Book of the Runtime FAQ](botr/botr-faq.md) +The Book of the Runtime is a set of chapters that go in depth into various +interesting aspects of the design of the .NET Framework. + +- [Book of the Runtime](botr/_tableOfContents.md) + +For your convenience, here are a a few quick links to popular chapters. + - [Introduction to the Common Language Runtime](botr/intro-to-clr.md) - [Garbage Collection Design](botr/garbage-collection.md) -- [Threading](botr/threading.md) -- [RyuJIT Overview](botr/ryujit-overview.md) - [Type System](botr/type-system.md) -- [Type Loader](botr/type-loader.md) -- [Method Descriptor](botr/method-descriptor.md) -- [Virtual Stub Dispatch](botr/virtual-stub-dispatch.md) -- [Stack Walking](botr/stackwalking.md) -- [Mscorlib and Calling Into the Runtime](botr/mscorlib.md) -- [Data Access Component (DAC) Notes](botr/dac-notes.md) -- [Profiling](botr/profiling.md) -- [Implementing Profilability](botr/profilability.md) -- [What Every Dev needs to Know About Exceptions in the Runtime](botr/exceptions.md) -- [ReadyToRun Overview](botr/readytorun-overview.md) -- [CLR ABI](botr/clr-abi.md) Decoder Rings ============= diff --git a/Documentation/botr/_tableOfContents.md b/Documentation/botr/_tableOfContents.md new file mode 100644 index 0000000000..549d3fc772 --- /dev/null +++ b/Documentation/botr/_tableOfContents.md @@ -0,0 +1,30 @@ + +Welcome to the Book of the (.NET) Runtime (BOTR). + +Below is a table of contents. + +- [Book of the Runtime FAQ](botr-faq.md) +- [Introduction to the Common Language Runtime](intro-to-clr.md) +- [Garbage Collection Design](garbage-collection.md) +- [Threading](threading.md) +- [RyuJIT Overview](ryujit-overview.md) + - [Porting RyuJIT to other platforms](porting-ryujit.md) +- [Type System](type-system.md) +- [Type Loader](type-loader.md) +- [Method Descriptor](method-descriptor.md) +- [Virtual Stub Dispatch](virtual-stub-dispatch.md) +- [Stack Walking](stackwalking.md) +- [Mscorlib and Calling Into the Runtime](mscorlib.md) +- [Data Access Component (DAC) Notes](dac-notes.md) +- [Profiling](profiling.md) +- [Implementing Profilability](profilability.md) +- [What Every Dev needs to Know About Exceptions in the Runtime](exceptions.md) +- [ReadyToRun Overview](readytorun-overview.md) +- [CLR ABI](clr-abi.md) + + +It may be possible that this table is not complete. You can get a complete list +by looking at the directory where all the chapters are stored on +github. + +* [All book of the runtime (BOTR) chapters on GitHub](https://github.com/vancem/coreclr/tree/master/Documentation/botr) |