summaryrefslogtreecommitdiff
path: root/Documentation/README.md
diff options
context:
space:
mode:
authorZlatko Knezevic <zlakne@microsoft.com>2015-06-06 20:29:39 -0700
committerblackdwarf <zlakne@zlakne-bigun.redmond.corp.microsoft.com>2015-06-10 09:50:32 -0700
commit8d3936bff7ae46a5a964b15b5f0bc3eb8d4e32db (patch)
treedc6a3218d66b4e69519d92f67edaab38125e57f3 /Documentation/README.md
parentee0f46644e0f3abe02122dcff125ac8b18c7db9d (diff)
downloadcoreclr-8d3936bff7ae46a5a964b15b5f0bc3eb8d4e32db.tar.gz
coreclr-8d3936bff7ae46a5a964b15b5f0bc3eb8d4e32db.tar.bz2
coreclr-8d3936bff7ae46a5a964b15b5f0bc3eb8d4e32db.zip
Add subfolders to Documentation folder
As raised in #1075 by @akoeplinger, the Documentation folder's file list forces the user to scroll way down to see the README.md. This PR fixes that by storing the documents in separate sub-folders one per hierarchy of related documents. Also changed Documentation\README.md and root README.md to take into account the new paths.
Diffstat (limited to 'Documentation/README.md')
-rw-r--r--Documentation/README.md80
1 files changed, 40 insertions, 40 deletions
diff --git a/Documentation/README.md b/Documentation/README.md
index 93b618668e..5cd69e7f82 100644
--- a/Documentation/README.md
+++ b/Documentation/README.md
@@ -12,71 +12,71 @@ Learn about .NET Core
Get .NET Core
=============
-- [Get .NET Core DNX SDK on Windows](get-dotnetcore-dnx-windows.md)
-- [Get .NET Core DNX SDK on OS X](get-dotnetcore-dnx-osx.md)
-- [Get .NET Core DNX SDK on Linux](get-dotnetcore-dnx-linux.md)
-- [Get .NET Core (Raw) on Windows](get-dotnetcore-windows.md)
+- [Get .NET Core DNX SDK on Windows](installing/get-dotnetcore-dnx-windows.md)
+- [Get .NET Core DNX SDK on OS X](installing/get-dotnetcore-dnx-osx.md)
+- [Get .NET Core DNX SDK on Linux](installing/get-dotnetcore-dnx-linux.md)
+- [Get .NET Core (Raw) on Windows](installing/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)
+- [Developer Guide](project-docs/developer-guide.md)
+- [Project priorities](project-docs/project-priorities.md)
+- [Contributing to .NET Core](project-docs/contributing.md)
+- [Contributing Workflow](project-docs/contributing-workflow.md)
+- [Performance Guidelines](project-docs/performance-guidelines.md)
+- [Garbage Collector Guidelines](project-docs/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)
+- [CLR Coding Guide](coding-guidelines/clr-code-guide.md)
+- [CLR JIT Coding Conventions](coding-guidelines/clr-jit-coding-conventions.md)
+- [Cross Platform Performance and Eventing Design](coding-guidelines/cross-platform-performance-and-eventing.md)
Build CoreCLR from Source
=========================
-- [Building CoreCLR on FreeBSD](freebsd-instructions.md)
-- [Building CoreCLR on Linux](linux-instructions.md)
-- [Building CoreCLR on OS X](osx-instructions.md)
-- [Building CoreCLR on Windows](windows-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)
+- [Building CoreCLR on FreeBSD](building/freebsd-instructions.md)
+- [Building CoreCLR on Linux](building/linux-instructions.md)
+- [Building CoreCLR on OS X](building/osx-instructions.md)
+- [Building CoreCLR on Windows](building/windows-instructions.md)
+- [Debugging CoreCLR on Windows](building/windows-debugging-instructions.md)
+- [Testing Changes on Windows](building/windows-test-instructions.md)
+- [Testing with CoreFX](building/testing-with-corefx.md)
+- [Creating a Custom DNX](building/custom-dnx-instructions.md)
Book of the Runtime
===================
-- [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)
-- [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)
+- [Book of the Runtime FAQ](botr/botr-faq.md)
+- [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)
Decoder Rings
=============
-- [.NET Core Glossary](glossary.md)
-- [.NET Filename Encyclopedia](dotnet-filenames.md)
+- [.NET Core Glossary](decoders/glossary.md)
+- [.NET Filename Encyclopedia](decoders/dotnet-filenames.md)
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)
+- [.NET Standards (Ecma)](miscellaneous/dotnet-standards.md)
+- [CLR Configuration Knobs](miscellaneous/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)