X-Git-Url: http://wien.tomnetworks.com/gitweb/?a=blobdiff_plain;f=README.md;h=5aad9440a06112eb34bb89a82f8bd46fb2910640;hb=372145ed24d6fbbcdab2ff50f0d75a7bbf73e31f;hp=fb27ad04a64ca2b64119b5bf4788bf6a0e2f5d7d;hpb=438e3b5ac335f69a620d2db738626fca1d0c2980;p=mono.git diff --git a/README.md b/README.md index fb27ad04a64..5aad9440a06 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,10 @@ create cross platform applications. It is an open source implementation of Microsoft's .NET Framework based on the ECMA standards for C# and the Common Language Runtime. +The Mono project is part of the [.NET Foundation](http://www.dotnetfoundation.org/) + +[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mono/mono?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + 1. [Compilation and Installation](#compilation-and-installation) 2. [Using Mono](#using-mono) 3. [Directory Roadmap](#directory-roadmap) @@ -21,9 +25,9 @@ Officially supported architectures: Community supported architectures: -| debian-ppc64el | centos-s390x | -|-----------------------------|---------------------------| -| [![debian-ppc64el][11]][12] | [![centos-s390x][13]][14] | +| centos-s390x | +|---------------------------| +| [![centos-s390x][11]][12] | [1]: http://jenkins.mono-project.com/job/test-mono-mainline/label=debian-amd64/badge/icon [2]: http://jenkins.mono-project.com/job/test-mono-mainline/label=debian-amd64/ @@ -35,10 +39,8 @@ Community supported architectures: [8]: http://jenkins.mono-project.com/job/test-mono-mainline/label=debian-armhf/ [9]: https://ci.appveyor.com/api/projects/status/1e61ebdfpbiei58v/branch/master?svg=true [10]: https://ci.appveyor.com/project/ajlennon/mono-817/branch/master -[11]: http://jenkins.mono-project.com/job/test-mono-mainline-communityarchitectures/label=debian-ppc64el/badge/icon -[12]: http://jenkins.mono-project.com/job/test-mono-mainline-communityarchitectures/label=debian-ppc64el/ -[13]: http://jenkins.mono-project.com/job/test-mono-mainline-communityarchitectures/label=centos-s390x/badge/icon -[14]: http://jenkins.mono-project.com/job/test-mono-mainline-communityarchitectures/label=centos-s390x/ +[11]: https://jenkins.mono-project.com/job/z/label=centos-s390x/badge/icon +[12]: https://jenkins.mono-project.com/job/z/label=centos-s390x Compilation and Installation ============================ @@ -70,7 +72,7 @@ which contains just enough to run the 'mcs' compiler. You do this with: This will download and place the files appropriately so that you can then just run: - make EXTERNAL_MCS=${PWD}/mcs/class/lib/monolite/basic.exe + make The build will then use the files downloaded by `make get-monolite-latest`. @@ -80,8 +82,7 @@ Testing and Installation You can run the mono and mcs test suites with the command: `make check`. Expect to find a few test suite failures. As a sanity check, you -can compare the failures you got with [https://wrench.mono-project.com/Wrench/](https://wrench.mono-project.com/Wrench/) -and [http://jenkins.mono-project.com/](http://jenkins.mono-project.com/). +can compare the failures you got with [https://jenkins.mono-project.com/](https://jenkins.mono-project.com/). You can now install mono with: `make install` @@ -105,6 +106,8 @@ See the man pages for mono(1), mcs(1) and monodis(1) for further details. Directory Roadmap ================= +* `acceptance-tests/` - Optional third party test suites used to validate Mono against a wider range of test cases. + * `data/` - Configuration files installed as part of the Mono runtime. * `docs/` - Technical documents about the Mono runtime. @@ -145,13 +148,6 @@ runtime as an embedded library. * `scripts/` - Scripts used to invoke Mono and the corresponding program. -* `../olive/` - Incubation code from [Olive](https://github.com/mono/olive). - - * If the directory ../olive is present (as an -independent checkout) from the Mono module, that -directory is automatically configured to share the -same prefix than this module gets. - Contributing to Mono ==================== @@ -189,7 +185,7 @@ while `mono-sgen` uses the Simple Generational GC. * `--with-gc=[included, boehm, none]` - Selects the default Boehm garbage collector engine to use. - * *included*: (*slighty modified Boehm GC*) This is the default + * *included*: (*slightly modified Boehm GC*) This is the default value for the Boehm GC, and it's the most feature complete, it will allow Mono to use typed allocations and support the debugger. @@ -202,6 +198,13 @@ Disables the inclusion of a garbage collector. * This defaults to `included`. +* `--with-cooperative-gc` + + * If you pass this flag the Mono runtime is configured to only use + the cooperative mode of the garbage collector. If you do not pass + this flag, then you can control at runtime the use of the + cooperative GC mode by setting the `MONO_ENABLE_COOP` flag. + * `--with-tls=__thread,pthread` * Controls how Mono should access thread local storage, @@ -427,8 +430,10 @@ cycle. multiple CPUs to do its work. This helps performance on multi-CPU machines as the work is divided across CPUS. - * This option is not currently the default as we have -not done much testing with Mono. + * This option is not currently the default on OSX +as it runs into issues there. + + * This option only applies to the Boehm GC. * `--enable-dtrace` @@ -504,3 +509,15 @@ to do at all), first edit `.gitmodules` to point to the new location, then: The desired output diff is a change in `.gitmodules` to reflect the change in the remote URL, and a change in / where you see the desired change in the commit hash. + +License +======= + +See the LICENSE file for licensing information, and the PATENTS.TXT +file for information about Microsoft's patent grant. + +Mono Trademark Use Policy +======= + +The use of trademarks and logos for Mono can be found [here] (http://www.dotnetfoundation.org/legal/mono-tm). +