docs and licence
authorSteven McDonald <steven@steven-mcdonald.id.au>
Sat, 26 Nov 2011 05:01:36 +0000 (16:01 +1100)
committerSteven McDonald <steven@steven-mcdonald.id.au>
Sat, 26 Nov 2011 05:01:36 +0000 (16:01 +1100)
COPYING [new file with mode: 0644]
README

diff --git a/COPYING b/COPYING
new file mode 100644 (file)
index 0000000..495bf70
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,23 @@
+Copyright (c) 2011, Steven McDonald
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in the
+       documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL STEVEN MCDONALD BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/README b/README
index e9402a0..c29d20f 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.