add doc (not finished) about how to create a recipe

tito · tito · commit 4c475d34d258 · 2011-11-29T01:09:56.000+01:00
diff --git a/README.rst b/README.rst
@@ -76,6 +76,43 @@ Step 2, package your application::
     ...
 
 
+Available modules
+-----------------
+
+List of available modules: jpeg pil png sdl sqlite3
+
+The up-to-date list is available at:
+https://github.com/tito/python-for-android/tree/master/recipes
+
+Only hostpython and python are 2 mandatory recipes, used for building
+hostpython / target python libraries.
+
+
+Create your own recipes
+-----------------------
+
+A recipe is a script that contain the "definition" of a module to compile.
+The directory layout of a recipe for a <modulename> is something like::
+
+    python-for-android/recipes/<modulename>/recipe.sh
+    python-for-android/recipes/<modulename>/patches/
+    python-for-android/recipes/<modulename>/patches/fix-path.patch
+
+When building, all the recipe build must go to::
+
+    python-for-android/build/<modulename>/<archiveroot>
+
+For example, if you want to create a recipe for sdl, do::
+
+    cd python-for-android/recipes
+    mkdir sdl
+    cp recipe.sh.tmpl sdl/recipe.sh
+    sed -i 's#XXX#sdl' sdl/recipe.sh
+
+Then, edit the sdl/recipe.sh to adjust other information (version, url) and
+complete build function.
+
+
 Related project
 ---------------
 
diff --git a/recipes/recipe.sh.tmpl b/recipes/recipe.sh.tmpl
@@ -0,0 +1,49 @@
+#!/bin/bash
+
+#------------------------------------------------------------------------------
+# Recipe name
+# @author Your Name <youremail@bleh.com>
+#------------------------------------------------------------------------------
+
+# REPLACE ALL THE "xxx" OF THIS FILE WITH THE MODULE NAME
+# THEN REMOVE THIS ERROR AND EXIT
+error "not configure" && exit -1
+
+# priority of the recipe. python is compiled with priority 10.
+# to be compiled before python, use a number prior to 10
+# to be compiled after python, use a number after to 50 (recommanded)
+PRIORITY_xxx=15
+
+# version of your package
+VERSION_xxx=1.3
+
+# dependencies of this recipe
+DEPS_xxx=()
+
+# url of the package
+URL_xxx=http://www.libxxx.org/xxx-$VERSION_xxx.tar.gz
+
+# md5 of the package
+MD5_xxx=7176d5f1a0f2683bf1394e0de18c74bb
+
+# default build path
+BUILD_xxx=$BUILD_PATH/xxx/$(get_directory $URL_xxx)
+
+# default recipe path
+RECIPE_xxx=$RECIPES_PATH/xxx
+
+# function called for preparing source code if needed
+# (you can apply patch etc here.)
+function prebuild_xxx() {
+	true
+}
+
+# function called to build the source code
+function build_xxx() {
+	true
+}
+
+# function called after all the compile have been done
+function postbuild_xxx() {
+	true
+}
