docs/INSTALL.TXT

   1 Android NDK Installation
   2
   3 Introduction:
   4 -------------
   5
   6 Please read docs/OVERVIEW.TXT to understand what the Android NDK is and is not.
   7 This file gives instructions on how to properly setup your NDK.
   8
   9
  10 I. Requirements:
  11 ----------------
  12
  13 The Android NDK currently requires a Linux, OS X or Windows host operating system.
  14 Windows users will need to install Cygwin (http://www.cygwin.com) to use it. Note
  15 that running the NDK under MSys is not supported.
  16
  17 You will need to have the Android SDK and its dependencies installed. The NDK
  18 cannot generate final application packages (.apk files), only the shared library
  19 files that can go into them.
  20
  21
  22 IMPORTANT:
  23     The Android NDK can only be used to target system images using
  24     the Cupcake (1.5) or later releases of the platform.
  25
  26     This is due to subtle toolchain and ABI related changed that make
  27     it incompatible with 1.0 and 1.1 system images.
  28
  29 The NDK requires GNU Make 3.81 or later being available on your development
  30 system. Earlier versions of GNU Make might work but have not been tested.
  31
  32 You can check this by running 'make -v' from the command-line. The output
  33 should look like:
  34
  35     GNU Make 3.81
  36     Copyright (C) 2006  Free Software Foundation, Inc.
  37     ...
  38
  39 On certain systems, GNU Make might be available through a different command like
  40 'gmake' or 'gnumake'. For these systems, replace 'make' by the appropriate command
  41 when invoking the NDK build system as described in the documentation.
  42
  43 The NDK also requires a Nawk or GNU Awk executable being available on your
  44 development system. Note that the original 'awk' program doesn't implement
  45 the 'match' and 'substr' functions used by the NDK build system.
  46
  47 On Windows, you will need to install a recent release of Cygwin to use the NDK.
  48 See http://www.cygwin.com for instructions.
  49
  50
  51 II. Preparing your installation prebuilt cross-toolchain binaries:
  52 ------------------------------------------------------------------
  53
  54 After installing and unarchiving the NDK, you will need to run the following
  55 command from the root folder:
  56
  57   build/host-setup.sh
  58
  59 This will test your setup and make sure the NDK can work properly.