diff options
| author | Zlatko Knezevic <zlakne@microsoft.com> | 2015-06-06 20:29:39 -0700 |
|---|---|---|
| committer | blackdwarf <zlakne@zlakne-bigun.redmond.corp.microsoft.com> | 2015-06-10 09:50:32 -0700 |
| commit | 8d3936bff7ae46a5a964b15b5f0bc3eb8d4e32db (patch) | |
| tree | dc6a3218d66b4e69519d92f67edaab38125e57f3 /Documentation/project-docs/developer-guide.md | |
| parent | ee0f46644e0f3abe02122dcff125ac8b18c7db9d (diff) | |
| download | coreclr-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/project-docs/developer-guide.md')
| -rw-r--r-- | Documentation/project-docs/developer-guide.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/Documentation/project-docs/developer-guide.md b/Documentation/project-docs/developer-guide.md new file mode 100644 index 0000000000..af47d9e566 --- /dev/null +++ b/Documentation/project-docs/developer-guide.md @@ -0,0 +1,28 @@ +Developer Guide +=============== + +This guide provides instructions (mostly as links) on how to build the repo and implement improvements. It will expand over time. + +Building the repository +======================= + +The CoreCLR repo can be built from a regular, non-admin command prompt. The build produces CoreCLR (multiple native binaries), the mscorlib managed library and the accompanying tests. The repo can be built for the following platforms, using the provided instructions. + +| Chip | Windows | Linux | OS X | +| :---- | :-----: | :---: | :--: | +| x64 | ●| ◒| ◒ | +| x86 | ◯| ◯| ◯| +| ARM32 | ◯ | ◯| ◯ | +| | [Instructions](windows-instructions.md) | [Instructions](linux-instructions.md) | [Instructions](osx-instructions.md) | + +The CoreCLR build and test suite is a work in progress, as are the [building and testing instructions](../README.md). The .NET Core team and the community are improving Linux and OS X support on a daily basis are and adding more tests for all platforms. See [CoreCLR Issues](https://github.com/dotnet/coreclr/issues) to find out about specific work items or report issues. + +Understanding the TFS-Git Mirror +================================ + +The Microsoft team maintains a Microsoft-internal TFS server of CoreCLR. An automated system is used to flow changes in/out of GitHub. The mirroring infrastructure uses the following hint files to mirror a given TFS folder into GitHub and back: + +1. `.gitmirror` - any folder containing this file will **only** have its contained files mirrored. Subfolders are **not** mirrored. +2. `.gitmirrorall` - any folder containing this file will have all of its files **and** subfolders mirrored recursively. The subfolders do not need to have any hint files. + +Thus, if you add a new folder to be included as part of the CoreCLR build, it will also need to have one of the two hint files mentioned above. |