docs and licence

[android-debian.git] / README

diff --git a/README b/README
index e9402a0336f28b0b862e697a428d2111983f5da1..c29d20f71ab5a02b86bf62fa2e7071076ba93701 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,39 @@
+Introduction
+------------
+
 These scripts are intended to ease the process of bootstrapping a Debian
 chroot on an Android device. Instructions for installing such a chroot
 may be found at:
 
 http://www.steven-mcdonald.id.au/tutorials/debian_on_samsung_galaxy.shtml
+
+
+Overview
+--------
+
+These scripts come in pairs; the ones under android/ are to be executed
+in an Android environment, and the ones under debian/ get executed in a
+chroot by the Android scripts.
+
+These scripts are ready to roll if:
+
+- your Debian chroot lives in /debian,
+- you place the scripts under android/ in /data/local/bin/, and
+- you place the scripts under debian/ in /debian/usr/local/sbin/.
+
+If this is not the case, then you will need to modify these scripts to
+work for you.
+
+
+Starting Debian services at boot time
+-------------------------------------
+
+In order to run the debian-init script at boot time, you can add the
+following to /system/etc/init.local.rc:
+
+service debian /data/local/bin/debian-init
+    user root
+    group root
+
+For some reason, Android's init won't start Debian if supplied with the
+'oneshot' option, so do not use that.