README.md

   1 ## Why another Superuser?
   2 * Superuser should be open source. It's the gateway to root on your device. It must be open for independent security analysis. Obscurity (closed source) is not security.
   3 * Superuser should be NDK buildable. No internal Android references.
   4 * Superuser should also be AOSP buildable for those that want to embed it in their ROM.
   5 * Superuser should also be AOSP _embeddable_, meaning a ROM can easily embed it into their Settings app.
   6 * Maintenance and updates on both the market and source repositories should be timely.
   7 * I want to be able to point users of my app to a Superuser solution that I wrote, that I know works, and that I can fix if something is wrong.
   8 * Handle multiuser (4.2+) properly
   9 * Handle concurrent su requests properly
  10
  11 ## Translations
  12
  13 Translations are very much appreciated, but please do not submit translations on Github! Instead, use the review submission process on [CyanogenMod's gerrit instance](http://review.cyanogenmod.org/#/q/status:open,n,z).
  14
  15
  16
  17 ## Checking out the source
  18
  19 You'll need the "Widgets" dependency.
  20
  21 * $ mkdir /path/to/src
  22 * $ cd /path/to/src
  23 * $ git clone git://github.com/koush/Superuser
  24 * $ git clone git://github.com/koush/Widgets
  25
  26 These repositories do not keep the actual projects in the top level directory.
  27 This is because they contain tests, libs, and samples.
  28
  29 ## Eclipse
  30
  31 In Eclipse, import Widgets/Widgets and Superuser/Superuser. It should Just Work (TM).
  32
  33 ## Ant
  34
  35 * $ mkdir /path/to/src
  36 * $ cd /path/to/src
  37 * $ cd Superuser/Superuser
  38
  39 In this directory, create a file called local.properties. This file is used by ant for custom properties. You need to specify the location of the ndk directory:
  40
  41 ```
  42 ndk.dir=/Users/koush/src/android-ndk
  43 ```
  44
  45 Then you can build:
  46
  47 * $ ant release
  48
  49 Outputs:
  50 * bin/update.zip - Recovery installable zip
  51 * bin/Superuser.apk - Superuser Android app
  52 * libs/armeabi/su - ARM su binary
  53 * libs/x86/su - x86 su binary
  54
  55 ## Building the su binary
  56
  57 You can use ant as shown above, to build the binary, but it can also be built without building the APK.
  58
  59 Make sure you have the android-ndk downloaded with the tool "ndk-build" in your path.
  60
  61 * $ cd /path/to/src/
  62 * $ cd Superuser/Superuser
  63 * $ ndk-build
  64
  65 The su binary will built into Superuser/Superuser/libs/armeabi/su.
  66
  67
  68
  69 ## Building with AOSP, CyanogenMod, etc
  70
  71 ROM developers are welcome to distribute the official Superuser APK and binary that I publish. That will
  72 allow them to receive updates with Google Play. However, you can also build Superuser as part of your
  73 build, if you choose to.
  74
  75 There are two ways to include Superuser in your build. The easiest is to build the APK as a separate app.
  76 To do that, simply add the local_manifest.xml as described below. The second way is by embedding it
  77 into the native Android System Settings.
  78
  79 #### Repo Setup
  80 Add the [local_manifest.xml](https://github.com/koush/Superuser/blob/master/local_manifest.xml) to your .repo/local_manifests
  81
  82 #### Configuring the Package Name
  83 The Superuser distributed on Google Play is in the package name com.koushikdutta.superuser.
  84 To prevent conflicts with the Play store version, the build process changes the package
  85 name to com.thirdparty.superuser. You can configure this value by setting the following
  86 in your vendor makefile or BoardConfig:
  87
  88 ```
  89 SUPERUSER_PACKAGE := com.mypackagename.superuser
  90 ```
  91
  92 #### Advanced - Embedding Superuser into System Settings
  93
  94 You will not need to change the package name as described above. Superuser will simply go
  95 into the com.android.settings package.
  96
  97 First, in a product makefile (like vendor/cm/config/common.mk), specify the following:
  98
  99 ```
 100 SUPERUSER_EMBEDDED := true
 101 ```
 102
 103 To modify packages/apps/Settings, you will need this [patch](http://review.cyanogenmod.org/#/c/32957/2//COMMIT_MSG,unified).
 104 The patch simply references the sources checked out to external/koush and makes changes
 105 to XML preference files and the AndroidManifest.xml. It is a very minimal change.
 106