diff options
author | Zlatko Knezevic <zlakne@microsoft.com> | 2015-06-17 17:53:44 +0300 |
---|---|---|
committer | Zlatko Knezevic <zlakne@microsoft.com> | 2015-06-24 02:48:06 +0300 |
commit | 06a5ba78cf8129605261fe8d2b1eb45069d53d68 (patch) | |
tree | 454d19ee70510582122e5eb9dd988bff2c46b104 /Documentation/README.md | |
parent | 61c837a2b210001c254393bc30a71f84dbf03c8f (diff) |
Add folders to CoreFX Documentation
Align to the way CoreCLR is handling its Documentation folder in the
repo. Add folders. Changed README.md in root, Documentation as well as
CONTRIBUTING.md with new links.
Diffstat (limited to 'Documentation/README.md')
-rw-r--r-- | Documentation/README.md | 60 |
1 files changed, 32 insertions, 28 deletions
diff --git a/Documentation/README.md b/Documentation/README.md index 7e3248f23b..cda8094b2b 100644 --- a/Documentation/README.md +++ b/Documentation/README.md @@ -1,58 +1,62 @@ Documents Index =============== +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 ==================== -- [Brief Intro to .NET Core](https://github.com/dotnet/coreclr/blob/master/Documentation/dotnetcore-intro.md) - [[WIP] Official .NET Core Docs](http://dotnet.readthedocs.org) Get .NET Core ============= -- [Get .NET Core DNX SDK on Windows](https://github.com/dotnet/coreclr/blob/master/Documentation/get-dotnetcore-dnx-windows.md) -- [Get .NET Core DNX SDK on OS X](https://github.com/dotnet/coreclr/blob/master/Documentation/get-dotnetcore-dnx-osx.md) -- [Get .NET Core DNX SDK on Linux](https://github.com/dotnet/coreclr/blob/master/Documentation/get-dotnetcore-dnx-linux.md) -- [Get .NET Core (Raw) on Windows](https://github.com/dotnet/coreclr/blob/master/Documentation/get-dotnetcore-windows.md) +- [Get .NET Core DNX SDK on Windows](https://github.com/dotnet/coreclr/blob/master/Documentation/install/get-dotnetcore-dnx-windows.md) +- [Get .NET Core DNX SDK on OS X](https://github.com/dotnet/coreclr/blob/master/Documentation/install/get-dotnetcore-dnx-osx.md) +- [Get .NET Core DNX SDK on Linux](https://github.com/dotnet/coreclr/blob/master/Documentation/install/get-dotnetcore-dnx-linux.md) +- [Get .NET Core (Raw) on Windows](https://github.com/dotnet/coreclr/blob/master/Documentation/install/get-dotnetcore-windows.md) Project Docs ============ -- [Developer Guide](developer-guide.md) -- [Project priorities](https://github.com/dotnet/coreclr/blob/master/Documentation/project-priorities.md) -- [Contributing to CoreFX](contributing.md) -- [Contributing to .NET Core](https://github.com/dotnet/coreclr/blob/master/Documentation/contributing.md) -- [Contributing Workflow](https://github.com/dotnet/coreclr/blob/master/Documentation/contributing-workflow.md) -- [Issue Guide](issue-guide.md) -- [Branching Guide](branching-guide.md) -- [API Review Process](api-review-process.md) -- [Strong Name Signing](strong-name-signing.md) -- [Open Source Signing](oss-signing.md) -- [Repo Organization](repo-organization.md) +- [Developer Guide](project-docs/developer-guide.md) +- [Project priorities](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/project-priorities.md) +- [Contributing to CoreFX](project-docs/contributing.md) +- [Contributing to .NET Core](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/contributing.md) +- [Contributing Workflow](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/contributing-workflow.md) +- [Issue Guide](project-docs/issue-guide.md) +- [Branching Guide](project-docs/branching-guide.md) +- [API Review Process](project-docs/api-review-process.md) +- [Strong Name Signing](project-docs/strong-name-signing.md) +- [Open Source Signing](project-docs/oss-signing.md) +- [Repo Organization](project-docs/repo-organization.md) Coding Guidelines ================= -- [C# coding style](coding-style.md) -- [Framework Design Guidelines](framework-design-guidelines-digest.md) -- [Cross-Platform Guidelines](cross-platform-guidelines.md) -- [Performance Guidelines](performance-guidelines.md) -- [Interop Guidelines](interop-guidelines.md) -- [Breaking Changes](breaking-changes.md) -- [Breaking Change Definitions](breaking-change-definitions.md) -- [Breaking Change Rules](breaking-change-rules.md) +- [C# coding style](coding-guidelines/coding-style.md) +- [Framework Design Guidelines](coding-guidelines/framework-design-guidelines-digest.md) +- [Cross-Platform Guidelines](coding-guidelines/cross-platform-guidelines.md) +- [Performance Guidelines](coding-guidelines/performance-guidelines.md) +- [Interop Guidelines](coding-guidelines/interop-guidelines.md) +- [Breaking Changes](coding-guidelines/breaking-changes.md) +- [Breaking Change Definitions](coding-guidelines/breaking-change-definitions.md) +- [Breaking Change Rules](coding-guidelines/breaking-change-rules.md) Building from Source ==================== -- [Building CoreFX on FreeBSD, Linux and OS X](unix-instructions.md) -- [Code Coverage](code-coverage.md) +- [Building CoreFX on FreeBSD, Linux and OS X](building/unix-instructions.md) +- [Code Coverage](building/code-coverage.md) Other Information ================= - [CoreCLR Repo documentation](https://github.com/dotnet/coreclr/tree/master/Documentation) -- [Porting to .NET Core](support-dotnet-core-instructions.md) -- [.NET Standards (Ecma)](https://github.com/dotnet/coreclr/blob/master/Documentation/dotnet-standards.md) +- [Porting to .NET Core](project-docs/support-dotnet-core-instructions.md) +- [.NET Standards (Ecma)](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/dotnet-standards.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) |