1
0
Fork 0
mirror of https://github.com/VSadov/Satori.git synced 2025-06-12 02:30:29 +09:00

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.


Commit migrated from 06a5ba78cf
This commit is contained in:
Zlatko Knezevic 2015-06-17 07:53:44 -07:00
parent e5524d66c0
commit 3f2ac8ff38
21 changed files with 41 additions and 37 deletions

View file

@ -1,58 +1,62 @@
Documents Index 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 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) - [[WIP] Official .NET Core Docs](http://dotnet.readthedocs.org)
Get .NET Core 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 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/get-dotnetcore-dnx-osx.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/get-dotnetcore-dnx-linux.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/get-dotnetcore-windows.md) - [Get .NET Core (Raw) on Windows](https://github.com/dotnet/coreclr/blob/master/Documentation/install/get-dotnetcore-windows.md)
Project Docs Project Docs
============ ============
- [Developer Guide](developer-guide.md) - [Developer Guide](project-docs/developer-guide.md)
- [Project priorities](https://github.com/dotnet/coreclr/blob/master/Documentation/project-priorities.md) - [Project priorities](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/project-priorities.md)
- [Contributing to CoreFX](contributing.md) - [Contributing to CoreFX](project-docs/contributing.md)
- [Contributing to .NET Core](https://github.com/dotnet/coreclr/blob/master/Documentation/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/contributing-workflow.md) - [Contributing Workflow](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/contributing-workflow.md)
- [Issue Guide](issue-guide.md) - [Issue Guide](project-docs/issue-guide.md)
- [Branching Guide](branching-guide.md) - [Branching Guide](project-docs/branching-guide.md)
- [API Review Process](api-review-process.md) - [API Review Process](project-docs/api-review-process.md)
- [Strong Name Signing](strong-name-signing.md) - [Strong Name Signing](project-docs/strong-name-signing.md)
- [Open Source Signing](oss-signing.md) - [Open Source Signing](project-docs/oss-signing.md)
- [Repo Organization](repo-organization.md) - [Repo Organization](project-docs/repo-organization.md)
Coding Guidelines Coding Guidelines
================= =================
- [C# coding style](coding-style.md) - [C# coding style](coding-guidelines/coding-style.md)
- [Framework Design Guidelines](framework-design-guidelines-digest.md) - [Framework Design Guidelines](coding-guidelines/framework-design-guidelines-digest.md)
- [Cross-Platform Guidelines](cross-platform-guidelines.md) - [Cross-Platform Guidelines](coding-guidelines/cross-platform-guidelines.md)
- [Performance Guidelines](performance-guidelines.md) - [Performance Guidelines](coding-guidelines/performance-guidelines.md)
- [Interop Guidelines](interop-guidelines.md) - [Interop Guidelines](coding-guidelines/interop-guidelines.md)
- [Breaking Changes](breaking-changes.md) - [Breaking Changes](coding-guidelines/breaking-changes.md)
- [Breaking Change Definitions](breaking-change-definitions.md) - [Breaking Change Definitions](coding-guidelines/breaking-change-definitions.md)
- [Breaking Change Rules](breaking-change-rules.md) - [Breaking Change Rules](coding-guidelines/breaking-change-rules.md)
Building from Source Building from Source
==================== ====================
- [Building CoreFX on FreeBSD, Linux and OS X](unix-instructions.md) - [Building CoreFX on FreeBSD, Linux and OS X](building/unix-instructions.md)
- [Code Coverage](code-coverage.md) - [Code Coverage](building/code-coverage.md)
Other Information Other Information
================= =================
- [CoreCLR Repo documentation](https://github.com/dotnet/coreclr/tree/master/Documentation) - [CoreCLR Repo documentation](https://github.com/dotnet/coreclr/tree/master/Documentation)
- [Porting to .NET Core](support-dotnet-core-instructions.md) - [Porting to .NET Core](project-docs/support-dotnet-core-instructions.md)
- [.NET Standards (Ecma)](https://github.com/dotnet/coreclr/blob/master/Documentation/dotnet-standards.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) - [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) - [Wikipedia Entry for the CLR](http://en.wikipedia.org/wiki/Common_Language_Runtime)

View file

@ -5,7 +5,7 @@ Different applications have different needs when it comes to performance. For l
Much has been written about writing high-performance code in C#. This page provides links to some of that material and will expand over time as additional resources are found and identified as being relevant and useful. Much has been written about writing high-performance code in C#. This page provides links to some of that material and will expand over time as additional resources are found and identified as being relevant and useful.
You can read [CoreCLR Performance Requirements](https://github.com/master/coreclr/blob/master/Documentation/performance-requirements.md) to learn more. You can read [CoreCLR Performance Requirements](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/performance-guidelines.md) to learn more.
# Memory Management # Memory Management

View file

@ -21,7 +21,7 @@ For trivial code changes, such as typo fixes, we want folks to directly submit a
For work that involves adding new APIs we'd like the issue to contain what we call a *speclet*. The speclet should provide a rough sketch of how the APIs are intended to be used, with sample code that shows typical scenarios. The goal isn't to be complete but rather to illustrate the direction so that readers can judge whether the proposal is sound. Here is [a good example](https://github.com/dotnet/corefx/issues/271). For work that involves adding new APIs we'd like the issue to contain what we call a *speclet*. The speclet should provide a rough sketch of how the APIs are intended to be used, with sample code that shows typical scenarios. The goal isn't to be complete but rather to illustrate the direction so that readers can judge whether the proposal is sound. Here is [a good example](https://github.com/dotnet/corefx/issues/271).
![API Review Process](images/api-review-process.png) ![API Review Process](../images/api-review-process.png)
## Steps ## Steps

View file

@ -1,7 +1,7 @@
Contributing to CoreFX Contributing to CoreFX
====================== ======================
This document describes contribution guidelines that are specific to CoreFX. Please read [.NET Core Guidelines](https://github.com/dotnet/coreclr/blob/master/Documentation/contributing.md) for more general .NET Core contribution guidelines. This document describes contribution guidelines that are specific to CoreFX. Please read [.NET Core Guidelines](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/contributing.md) for more general .NET Core contribution guidelines.
Coding Style Changes Coding Style Changes
-------------------- --------------------

View file

@ -12,15 +12,15 @@ Want to make your libraries multi-platform? Want to see how much work is require
To begin using the .NET Portability Analyzer, download the extension from the Visual Studio Gallery. You can configure it in Visual Studio via *Tools* >> *Options* >> *.NET Portability Analyzer* and select your Target Platforms. For now, please use ASP.NET 5 as a proxy for all .NET Core 5-based platforms (e.g. [Windows 10 .NET UAP apps](http://blogs.windows.com/buildingapps/2015/03/02/a-first-look-at-the-windows-10-universal-app-platform/)). To begin using the .NET Portability Analyzer, download the extension from the Visual Studio Gallery. You can configure it in Visual Studio via *Tools* >> *Options* >> *.NET Portability Analyzer* and select your Target Platforms. For now, please use ASP.NET 5 as a proxy for all .NET Core 5-based platforms (e.g. [Windows 10 .NET UAP apps](http://blogs.windows.com/buildingapps/2015/03/02/a-first-look-at-the-windows-10-universal-app-platform/)).
![](images/portability_screenshot.png) ![](../images/portability_screenshot.png)
To analyze your entire project, right-click on your project in the Solution Explorer and select *Analyze* >> *Analyze Assembly Portability*. Otherwise, go to the Analyze menu and select *Analyze Assembly Portability*. From there, select your project's executable or .dll. To analyze your entire project, right-click on your project in the Solution Explorer and select *Analyze* >> *Analyze Assembly Portability*. Otherwise, go to the Analyze menu and select *Analyze Assembly Portability*. From there, select your project's executable or .dll.
![](images/portability_solution_explorer.png) ![](../images/portability_solution_explorer.png)
After running the analysis, you will see your .NET Portability Report. Only types that are unsupported by a target platform will appear in the list and you can review recommendations in the **Messages** tab in the **Error List**. You can also jump to problem areas directly from the **Messages** tab. After running the analysis, you will see your .NET Portability Report. Only types that are unsupported by a target platform will appear in the list and you can review recommendations in the **Messages** tab in the **Error List**. You can also jump to problem areas directly from the **Messages** tab.
![](images/portability_report.png) ![](../images/portability_report.png)
Don't want to use Visual Studio? You can also use the Portability Analyzer from the Command Prompt. Download the command-line analyzer [here](http://www.microsoft.com/en-us/download/details.aspx?id=42678). Don't want to use Visual Studio? You can also use the Portability Analyzer from the Command Prompt. Download the command-line analyzer [here](http://www.microsoft.com/en-us/download/details.aspx?id=42678).