Added basic quickstart doc

inclement · inclement · commit 7e28940c771a · 2015-06-28T16:58:27.000+01:00
diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst
@@ -6,3 +6,55 @@ These simple steps run through the most simple procedure to create an
 APK with some simple default parameters. See the :doc:`commands
 documentation <commands>` for all the different commands and build
 options available.
+
+.. warning:: These instructions are quite preliminary. The
+             installation and use process will become more standard in
+             the near future.
+             
+
+Installation
+------------
+
+You can obtain python-for-android from Github, either via git::
+
+  git clone git@github.com:inclement/python-for-android-revamp.git
+  cd python-for-android
+  
+Or by direct download::
+
+  wget https://github.com/inclement/python-for-android-revamp/archive/master.zip
+  unzip master.zip
+  cd python-for-android-revamp-master
+
+  
+Basic use
+---------
+
+Navigate to the ``pythonforandroid`` directory within the downloaded package.
+
+.. note:: This will soon be replaced with a normal call to setup.py,
+          but this hasn't been finished and tested yet.
+          
+You need to set ANDROIDSDK and ANDROIDNDK env vars to point to these.
+
+To create a basic distribution, run .e.g::
+
+     python2 toolchain.py create --name=testproject --bootstrap=pygame --recipes=sdl,python2
+     
+These arguments relate to the old python-for-android; ``name`` is the
+dist name, and ``recipes`` is a list of recipes to use. The build
+should proceed and eventually finish, and will print the location of
+the dist.
+
+.. note:: Compiled dists are not located in the same place as with old
+          python-for-android, but instead in an OS-dependent
+          location. The build process will print this location when it
+          finishes.
+         
+To build an APK, navigate to the dist dir and run build.py just as with old p4a.
+
+You can build an SDL2 APK similarly, first making a dist::
+
+    python2 toolchain.py create --name=testsdl2 --bootstrap=sdl2 --recipes=sdl2,python2
+
+This will have a build.py in the same way, but currently doesn't support many options.
diff --git a/doc/source/recipes.rst b/doc/source/recipes.rst
@@ -374,6 +374,18 @@ what the jni dir folder name should be. If it is omitted, the recipe
 name is used. Be careful here, sometimes the folder name is important,
 especially if this folder is a dependency of something else.
 
+Examples of recipes
+-------------------
+
+The above documentation has included a number of snippets
+demonstrating different behaviour. Together, these cover most of what
+is ever necessary to make a recipe work.
+
+The following short sections further demonstrate a few full recipes from p4a's
+internal recipes folder. Unless your own module has some unusual
+complication, following these templates should be all you need to make
+your own recipes work. 
+
 .. _recipe_class:
 
 The ``Recipe`` class
