summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordotnet-bot <dotnet-bot@microsoft.com>2015-01-30 14:14:42 -0800
committerdotnet-bot <dotnet-bot@microsoft.com>2015-01-30 14:14:42 -0800
commitef1e2ab328087c61a6878c1e84f4fc5d710aebce (patch)
treedee1bbb89e9d722e16b0d1485e3cdd1b6c8e2cfa /README.md
downloadcoreclr-ef1e2ab328087c61a6878c1e84f4fc5d710aebce.tar.gz
coreclr-ef1e2ab328087c61a6878c1e84f4fc5d710aebce.tar.bz2
coreclr-ef1e2ab328087c61a6878c1e84f4fc5d710aebce.zip
Initial commit to populate CoreCLR repo
[tfs-changeset: 1407945]
Diffstat (limited to 'README.md')
-rw-r--r--README.md62
1 files changed, 62 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..c6b85fbc90
--- /dev/null
+++ b/README.md
@@ -0,0 +1,62 @@
+# .NET Core Runtime (CoreCLR)
+
+The coreclr repo contains the runtime implementation for [.NET Core](http://github.com/dotnet/core), also known as "CoreCLR". CoreCLR is used in ASP.NET 5 and is a subset of the .NET Framework CLR. You can learn more about CoreCLR and how and where you can use it in the [CoreCLR is Open Source][coreclr blog post] blog post.
+
+The repo contains the complete implementation of CoreCLR, including RyuJIT and the .NET GC. It builds and runs on Windows. You can 'watch' the repo to see Linux and Mac support being added over the next few months.
+
+The [.NET Core Libraries][corefx] repo contains the base class libraries, which run on top of CoreCLR. The two repos together make up .NET Core. The [.NET Core is Open Source][blog post] blog post describes our .NET Core OSS strategy and road map in more detail.
+
+## How to Engage, Contribute and Provide Feedback
+
+Some of the best ways to contribute are to try things out, file bugs, and join in design conversations.
+
+Want to get more familiar with what's going on in the code?
+* [Pull requests](https://github.com/dotnet/coreclr/pulls): [Open](https://github.com/dotnet/coreclr/pulls?q=is%3Aopen+is%3Apr)/[Closed](https://github.com/dotnet/coreclr/pulls?q=is%3Apr+is%3Aclosed)
+
+Looking for something to work on? The list of [up-for-grabs issues](https://github.com/dotnet/coreclr/issues?q=is%3Aopen+is%3Aissue+label%3Aup-for-grabs) is a great place to start.
+
+* [Contributing Guide][Contributing Guide]
+* [Developer Guide]
+
+You are encouraged to start a discussion by filing an issue, creating a
+gist or starting a thread in the [.NET Foundation forums]. For broader topics, please use the forums.
+
+[Contributing Guide]: https://github.com/dotnet/coreclr/wiki/Contributing
+[Developer Guide]: https://github.com/dotnet/coreclr/wiki/Developer-Guide
+
+[.NET Foundation forums]: http://forums.dotnetfoundation.org/
+
+## CoreCLR Build Artifacts
+The build for this repo will produce the following artifacts:
+
+1. coreclr.dll and required native binaries
+2. mscorlib.dll
+3. Tests that are required for validating any changes to the product
+
+## Code Flow
+CoreCLR is a subset of the .NET Framework CLR. They share the same codebase and are updated together. For example, an update to the .NET GC improves both CoreCLR and the .NET Framework CLR.
+
+We setup a live 2-way mirror between the coreclr repo on GitHub and the .NET Framework TFS server within Microsoft. The latency of the mirror is low, measurable in minutes.
+
+Contributions made to the coreclr repo are integrated to the Microsoft TFS server automatically and will become part of both the .NET Framework and .NET Core products. The same is true in reverse, that .NET Framework CLR changes (within the CoreCLR subset) are mirrored to the CoreCLR repo. These changes will sometimes result in large commits to unrelated components.
+
+## License
+
+.NET Core (including the coreclr repo) is licensed under the [MIT license](LICENSE).
+
+## .NET Foundation
+
+.NET Core is a [.NET Foundation](http://www.dotnetfoundation.org/projects) project.
+
+## Related Projects
+There are many .NET related projects on GitHub.
+
+- The
+[.NET home repo](https://github.com/Microsoft/dotnet) links to 100s of .NET projects, from Microsoft and the community.
+- The [.NET Core repo](https://github.com/dotnet/core) links to .NET Core related projects from Microsoft.
+- The [ASP.NET home repo](https://github.com/aspnet/home) is the best place to start learning about ASP.NET 5.
+- [dotnet.github.io](http://dotnet.github.io) is a good place to discover .NET Foundation projects.
+
+[blog post]: http://blogs.msdn.com/b/dotnet/archive/2014/11/12/net-core-is-open-source.aspx
+[coreclr blog post]: http://blogs.msdn.com/b/dotnet/archive/2015/02/03/coreclr-is-open-source.aspx
+[corefx]: http://github.com/dotnet/corefx