| Newsgroups |
gmane.comp.gnome.mono.patches |
| Message-ID |
<0000014206880a24-8f74d9d7-281a-4575-ae15-9bc7a23ff0f5-000000@email.amazonses.com> |
Branch: refs/heads/readmeUpdate
Home: https://github.com/mono/mono
Compare: https://github.com/mono/mono/compare/b279873cfecf...1e107ece1fac
Commit: 1e107ece1facd8447d598938ecc59a215777f4ec
Author: Therzok <[email protected]> (Therzok)
Date: 2013-10-29 23:22:34 GMT
URL: https://github.com/mono/mono/commit/1e107ece1facd8447d598938ecc59a215777f4ec
Tryout
Changed paths:
M README.md
Modified: README.md
===================================================================
@@ -1,26 +1,26 @@
Mono is a software platform designed to allow developers to easily create cross platform applications.
Mono is an open source implementation of Microsoft's .NET Framework based on the ECMA standards for C# and the Common Language Runtime.
-1. <a href="#compilation-and-installation">Installation
-2. <a href="#using-mono">Using Mono</a>
-3. <a href="#directory-roadmap">Directory Roadmap</a>
-4. <a href="#git-submodules-maintenance">git submodules maintenance</a>
-5. <a href="#reporting-bugs">Reporting bugs</a>
+1. [Installation](#compilation-and-installation)
+2. [Using Mono](#using-mono)
+3. [Directory Roadmap](#directory-roadmap)
+4. [Git submodules maintenance](#git-submodules-maintenance)
+5. [Reporting bugs](#reporting-bugs)
-#### Compilation and Installation
-===============================
+Compilation and Installation
+============================
- a. Build Requirements
- ---------------------
+a. Build Requirements
+---------------------
- On Itanium, you must obtain libunwind:
+ * On Itanium, you must obtain libunwind:
- http://www.hpl.hp.com/research/linux/libunwind/download.php4
+`http://www.hpl.hp.com/research/linux/libunwind/download.php4`
- On Solaris, make sure that you used GNU tar to unpack this package, as
- Solaris tar will not unpack this correctly, and you will get strange errors.
+ * On Solaris, make sure that you used GNU tar to unpack this package, as
+Solaris tar will not unpack this correctly, and you will get strange errors.
- On Solaris, make sure that you use the GNU toolchain to build the software.
+ * On Solaris, make sure that you use the GNU toolchain to build the software.
Optional dependencies:
@@ -42,138 +42,138 @@ Mono is an open source implementation of Microsoft's .NET Framework based on the
This library and the development headers are required for compression
file support in the 2.0 profile.
- b. Building the Software
- ------------------------
-
- If you obtained this package as an officially released tarball,
- this is very simple, use configure and make:
+b. Building the Software
+------------------------
- ./configure --prefix=/usr/local
- make
- make install
+If you obtained this package as an officially released tarball,
+this is very simple, use configure and make:
- Mono supports a JIT engine on x86, SPARC, SPARCv9, S/390,
- S/390x, AMD64, ARM and PowerPC systems.
+`./configure --prefix=/usr/local ; make ; make install`
- If you obtained this as a snapshot, you will need an existing
- Mono installation. To upgrade your installation, unpack both
- mono and mcs:
+Mono supports a JIT engine on x86, SPARC, SPARCv9, S/390,
+S/390x, AMD64, ARM and PowerPC systems.
- tar xzf mcs-XXXX.tar.gz
- tar xzf mono-XXXX.tar.gz
- mv mono-XXX mono
- mv mcs-XXX mcs
- cd mono
- ./autogen.sh --prefix=/usr/local
- make
+If you obtained this as a snapshot, you will need an existing
+Mono installation. To upgrade your installation, unpack both
+mono and mcs:
- The Mono build system is silent for most compilation commands.
- To enable a more verbose compile (for example, to pinpoint
- problems in your makefiles or your system) pass the V=1 flag to make, like this:
+ tar xzf mcs-XXXX.tar.gz
+ tar xzf mono-XXXX.tar.gz
+ mv mono-XXX mono
+ mv mcs-XXX mcs
+ cd mono
+ ./autogen.sh --prefix=/usr/local
+ make
- make V=1
+The Mono build system is silent for most compilation commands.
+To enable a more verbose compile (for example, to pinpoint
+problems in your makefiles or your system) pass the V=1 flag to make, like this:
+` make V=1`
- c. Building the software from GIT
- ---------------------------------
- If you are building the software from GIT, make sure that you
- have up-to-date mcs and mono sources:
+c. Building the software from GIT
+---------------------------------
- If you are an anonymous user:
- git clone git://github.com/mono/mono.git
+If you are building the software from GIT, make sure that you
+have up-to-date mcs and mono sources:
- If you are a Mono contributors with read/write privileges:
- git clone [email protected]:mono/mono.git
+If you are an anonymous user:
+`git clone git://github.com/mono/mono.git`
- Then, go into the mono directory, and configure:
+If you are a Mono contributors with read/write privileges:
- cd mono
- ./autogen.sh --prefix=/usr/local
- make
+`git clone [email protected]:mono/mono.git`
- For people with non-standard installations of the auto* utils and of
- pkg-config (common on misconfigured OSX and windows boxes), you could get
- an error like this:
- ./configure: line 19176: syntax error near unexpected token `PKG_CHECK_MODULES(BASE_DEPENDENCIES,' ...
+Then, go into the mono directory, and configure:
- This means that you need to set the ACLOCAL_FLAGS environment var
- when invoking autogen.sh, like this:
+ cd mono
+ ./autogen.sh --prefix=/usr/local
+ make
- ACLOCAL_FLAGS="-I $acprefix/share/aclocal" ./autogen.sh --prefix=/usr/loca
-
- where $acprefix is the prefix where aclocal has been installed.
+For people with non-standard installations of the auto* utils and of
+pkg-config (common on misconfigured OSX and windows boxes), you could get
+an error like this:
- This will automatically go into the mcs/ tree and build the
- binaries there.
+`./configure: line 19176: syntax error near unexpected token `PKG_CHECK_MODULES(BASE_DEPENDENCIES,' ...`
- This assumes that you have a working mono installation, and that
- there's a C# compiler named 'mcs', and a corresponding IL
- runtime called 'mono'. You can use two make variables
- EXTERNAL_MCS and EXTERNAL_RUNTIME to override these. e.g., you
- can say
+This means that you need to set the ACLOCAL_FLAGS environment var
+when invoking autogen.sh, like this:
- make EXTERNAL_MCS=/foo/bar/mcs EXTERNAL_RUNTIME=/somewhere/else/mono
-
- If you don't have a working Mono installation
- ---------------------------------------------
+`ACLOCAL_FLAGS="-I $acprefix/share/aclocal" ./autogen.sh --prefix=/usr/local`
+
+where $acprefix is the prefix where aclocal has been installed.
+
+This will automatically go into the mcs/ tree and build the
+binaries there.
+
+This assumes that you have a working mono installation, and that
+there's a C# compiler named 'mcs', and a corresponding IL
+runtime called 'mono'. You can use two make variables
+EXTERNAL_MCS and EXTERNAL_RUNTIME to override these. e.g., you
+can say
- If you don't have a working Mono installation, an obvious choice
- is to install the latest released packages of 'mono' for your
- distribution and running autogen.sh; make; make install in the
- mono module directory.
+`make EXTERNAL_MCS=/foo/bar/mcs EXTERNAL_RUNTIME=/somewhere/else/mono`
- You can also try a slightly more risky approach: this may not work,
- so start from the released tarball as detailed above.
+If you don't have a working Mono installation
+---------------------------------------------
- This works by first getting the latest version of the 'monolite'
- distribution, which contains just enough to run the 'mcs'
- compiler. You do this with:
+If you don't have a working Mono installation, an obvious choice
+is to install the latest released packages of 'mono' for your
+distribution and running autogen.sh; make; make install in the
+mono module directory.
- # Run the following line after ./autogen.sh
- make get-monolite-latest
+You can also try a slightly more risky approach: this may not work,
+so start from the released tarball as detailed above.
- This will download and automatically gunzip and untar the
- tarball, and place the files appropriately so that you can then
- just run:
+This works by first getting the latest version of the 'monolite'
+distribution, which contains just enough to run the 'mcs'
+compiler. You do this with:
- make EXTERNAL_MCS=${PWD}/mcs/class/lib/monolite/gmcs.exe
+ # Run the following line after ./autogen.sh
+ make get-monolite-latest
- And that will use the files downloaded by 'make get-monolite-latest.
+This will download and automatically gunzip and untar the
+tarball, and place the files appropriately so that you can then
+just run:
- Testing and Installation
- ------------------------
+`make EXTERNAL_MCS=${PWD}/mcs/class/lib/monolite/gmcs.exe`
- You can run (part of) the mono and mcs testsuites with the command:
+And that will use the files downloaded by 'make get-monolite-latest.
- make check
+Testing and Installation
+------------------------
- All tests should pass.
+You can run (part of) the mono and mcs testsuites with the command:
- If you want more extensive tests, including those that test the
- class libraries, you need to re-run 'configure' with the
- '--enable-nunit-tests' flag, and try
+`make check`
- make -k check
+All tests should pass.
- Expect to find a few testsuite failures. As a sanity check, you
- can compare the failures you got with
+If you want more extensive tests, including those that test the
+class libraries, you need to re-run 'configure' with the
+'--enable-nunit-tests' flag, and try
- https://wrench.mono-project.com/Wrench/
+`make -k check`
- You can now install mono with:
+Expect to find a few testsuite failures. As a sanity check, you
+can compare the failures you got with
- make install
+`https://wrench.mono-project.com/Wrench/`
- You can verify your installation by using the mono-test-install
- script, it can diagnose some common problems with Mono's install.
+You can now install mono with:
- Failure to follow these steps may result in a broken installation.
+`make install`
- d. Configuration Options
- ------------------------
+You can verify your installation by using the mono-test-install
+script, it can diagnose some common problems with Mono's install.
+
+Failure to follow these steps may result in a broken installation.
+
+d. Configuration Options
+------------------------
The following are the configuration options that someone
building Mono might want to use:
@@ -504,30 +504,31 @@ Mono is an open source implementation of Microsoft's .NET Framework based on the
Currently this is used with Mono's AOT engine as
Native Client does not support JIT engines yet.
-2. Using Mono
-=============
+Using Mono
+==========
- Once you have installed the software, you can run a few programs:
+Once you have installed the software, you can run a few programs:
- * runtime engine
+ * runtime engine
- mono program.exe
+`mono program.exe`
- * C# compiler
+* C# compiler
- mcs program.cs
+`mcs program.cs`
- * CIL Disassembler
+* CIL Disassembler
- monodis program.exe
+`monodis program.exe`
- See the man pages for mono(1), mint(1), monodis(1) and mcs(2)
- for further details.
+See the man pages for mono(1), mint(1), monodis(1) and mcs(2)
+for further details.
-3. Directory Roadmap
-====================
+Directory Roadmap
+=================
+
+ * docs/
- docs/
Technical documents about the Mono runtime.
data/
@@ -588,21 +589,21 @@ Mono is an open source implementation of Microsoft's .NET Framework based on the
same prefix than this module gets.
-4. Git submodules maintenance
-=============================
+Git submodules maintenance
+==========================
Read documentation at http://mono-project.com/Git_Submodule_Maintenance
-5. Reporting bugs
-=================
+Reporting bugs
+==============
To submit bug reports, please use Xamarin's Bugzilla:
- https://bugzilla.xamarin.com/
+https://bugzilla.xamarin.com/
Please use the search facility to ensure the same bug hasn't already
been submitted and follow our guidelines on how to make a good bug
report:
- http://mono-project.com/Bugs#How_to_make_a_good_bug_report
+http://mono-project.com/Bugs#How_to_make_a_good_bug_report
_______________________________________________
Mono-patches maillist - [email protected]
http://lists.ximian.com/mailman/listinfo/mono-patches