Update play-audio to 0.2

[termux-packages] / README.md

diff --git a/README.md b/README.md
index 0359313..af9267f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,20 +3,35 @@ termux-packages
 This project contains scripts and patches to cross compile and package packages for
 the [Termux](http://termux.com/) Android application.
 
+NOTE: This is in a rough state - be prepared for some work and frustrations, and give
+feedback if you find incorrect our outdated things!
+
+Initial setup
+=============
+Building packages are for now only tested to work on Ubuntu 15.04. Perform the following
+setup steps:
+
+* Run `ubuntu-setup.sh` to install required packages and setup the `/data/` folder (see below).
+
+* Install the Android SDK at `$HOME/lib/android-sdk`. Override this by setting the environment
+variable `$ANDROID_HOME` to point at another location.
+
+* Install the Android NDK, version r10e, at `$HOME/lib/android-ndk`. Override this by setting
+the environment variable `$NDK` to point at another location.
+
 
 Building a package
 ==================
 In a non-rooted Android device an app such as Termux may not write to system locations,
 which is why every package is installed inside the private file area of the Termux app:
-       PREFIX=/data/data/com.termux/files/usr
+
+    PREFIX=/data/data/com.termux/files/usr
 
 For simplicity while developing and building, the build scripts here assume that a /data
-folder is reserved for use on the host builder, which requires setup:
-       sudo mkdir /data
-       sudo chown $USER /data
+folder is reserved for use on the host builder and install everything there.
 
-The basic flow is then to run "./build-package.sh $PKG", which
-- Sets up a patched stand-alone Android NDK toolchain
+The basic flow is then to run "./build-package.sh $PKG", which:
+* Sets up a patched stand-alone Android NDK toolchain
 
 * Reads packages/$PKG/build.sh to find out where to find the source code of the  package and how to build it.
 
@@ -24,7 +39,8 @@ The basic flow is then to run "./build-package.sh $PKG", which
 
 * Builds the package and installs it to $PREFIX
 
-* Packages the package in one or more .dpkg files for distribution
+* Creates a dpkg package file for distribution.
+
 Reading and following build-package.sh is the best way to understand what's going on here.
 
 
@@ -75,7 +91,7 @@ contains these and may be used by all packages.
 
 * <sys/fcntl.h> does not exist, but <fcntl.h> is the standard location.
 
-* glob(3) system function (glob.h) - not in bionic, but use the libglob package
+* glob(3) system function (glob.h) - not in bionic, but use the `libandroid-glob` package
 
 * undefined reference to 'rpl_malloc' and/or 'rpl_realloc': These functions are added by some autoconf setups
   when it fails to detect 0-safe malloc and realloc during cross-compilating. Avoided by defining
@@ -111,12 +127,12 @@ These differs from glibc ones in that
 RPATH, LD_LIBRARY_PATH AND RUNPATH
 ==================================
 On desktop linux the linker searches for shared libraries in:
+
 1. RPATH - a list of directories which is linked into the executable, supported on most UNIX systems. It is ignored if RUNPATH is present.
 2. LD_LIBRARY_PATH - an environment variable which holds a list of directories
-3. RUNPATH - same as RPATH, but searched after LD_LIBRARY_PATH, supported only on most recent UNIX systems, e.g. on most current Linux systems
-The Android linker (/system/bin/linker) does not support RPATH or RUNPATH, so we set LD_LIBRARY_PATH=$USR/lib and try to avoid building
-useless rpath entries with --disable-rpath configure flags.
-Another option to avoid depending on LD_LIBRARY_PATH would be supplying a custom linker - this is not done due to the overhead of maintaining a custom linker.
+3. RUNPATH - same as RPATH, but searched after LD_LIBRARY_PATH, supported only on most recent UNIX systems
+
+The Android linker (/system/bin/linker) does not support RPATH or RUNPATH, so we set LD_LIBRARY_PATH=$USR/lib and try to avoid building useless rpath entries with --disable-rpath configure flags. Another option to avoid depending on LD_LIBRARY_PATH would be supplying a custom linker - this is not done due to the overhead of maintaining a custom linker.
 
 
 Warnings about unused DT entries
@@ -157,6 +173,7 @@ To get files on device one option is:
     udpsvd -vE 0.0.0.0 8069 tftpd -c . # Run on device. -c arg to allow file uploading
     printf "mode binary\nput out.md\nquit" | tftp 192.168.0.12 8069 # on computer
 Another is with ftp:
+
     tcpsvd -vE 0.0.0.0 8021 ftpd -w . # Run on device. -w arg to allow file uploading
     printf "put tmp.c\nquit" | ftp -n 192.168.0.12 8021 # Run on computer. -n arg to use anonymous login
 NOTE: The ftpd and tftpd programs has been patched to run without chroot. This means that the directory serving is only the starting point and clients may cd out of if the access the whole system!