Skip to content

Commit 8f29737

Browse files
committed
[README] Expand the Build Requirements section.
Two common issues of those on the gitter.im channel when trying to build the xamarin-android repo are: 1. Not using Mono 4.4. 2. xxd(1) isn't installed. Update the Build Requirements section to better detail the other software packages which need to be installed in order to build the xamarin-android repo.
1 parent 54ef952 commit 8f29737

File tree

1 file changed

+42
-2
lines changed

1 file changed

+42
-2
lines changed

Diff for: README.md

+42-2
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,54 @@ Overridable MSBuild properties include:
4040

4141
# Build Requirements
4242

43-
Building Xamarin.Android requires the Java Development Kit (JDK), several
44-
pieces of the Android SDK, and the Android NDK.
43+
Building Xamarin.Android requires:
44+
45+
* [Mono 4.4 or later](#mono-sdk)
46+
* [The Java Development Kit (JDK)](#jdk)
47+
* [Autotools (`autoconf`, `automake`, etc.)](#autotools)
48+
* [`xxd`](#xxd)
49+
* [The Android SDK and NDK](#ndk)
50+
51+
<a name="mono-sdk" />
52+
## Mono MDK
53+
54+
Mono 4.4 or later is required to build on [OS X][osx-mono] and Linux.
55+
56+
(This is because the build system uses the [XmlPeek][xmlpeek] task, which
57+
was first added in Mono 4.4.)
58+
59+
[osx-mono]: http://www.mono-project.com/download/#download-mac
60+
[xmlpeek]: https://msdn.microsoft.com/en-us/library/ff598684.aspx
61+
62+
<a name="jdk" />
63+
## Java Development Kit
4564

4665
The Java Development Kit may be downloaded from the
4766
[Oracle Java SE Downloads page][download-jdk].
4867

4968
[download-jdk]: http://www.oracle.com/technetwork/java/javase/downloads/
5069

70+
<a name="autotools" />
71+
## Autotools
72+
73+
Autotools -- including `autoconf` and `automake` -- are required to build
74+
the Mono runtimes.
75+
76+
On OS X, autotools are distributed with [Mono.framework][osx-mono].
77+
78+
<a name="xxd" />
79+
## `xxd`
80+
81+
The [xxd][xxd] utility is used to build [src/monodroid](src/monodroid).
82+
It is installed by default on OS X. Linux users may need to separately
83+
install it; it may be part of the [vim-common` package][sid-vim-common].
84+
85+
[xxd]: http://linux.die.net/man/1/xxd
86+
[sid-vim-common]: https://packages.debian.org/sid/vim-common
87+
88+
<a name="ndk" />
89+
## Android NDK, SDK
90+
5191
To simplify building Xamarin.Android, important pieces of the Android SDK
5292
and Android NDK will be automatically downloaded and installed from
5393
Google's website. Downloaded files are cached locally, by default into

0 commit comments

Comments
 (0)