guide2: first pass to add bases of the programming guide new generation.

This commit is contained in:
Mathieu Virbel 2012-10-07 19:31:32 +02:00
parent fe3592161b
commit 520220f6a3
10 changed files with 179 additions and 0 deletions

View File

@ -25,4 +25,9 @@ stunning applications in short time using the framework.
contact
.. toctree::
:maxdepth: 3
guide2-index
.. include:: api-index.rst

View File

@ -0,0 +1,19 @@
Programming Guide 2
===================
.. warning::
We are currently refactoring the whole Programming Guide. This is a work in
progress, and might change at any times.
.. toctree::
:maxdepth: 2
guide2/basic
guide2/events
guide2/widgets
guide2/graphics
guide2/lang
guide2/bestpractices
guide2/advancedgraphics
guide2/packaging

View File

@ -0,0 +1,13 @@
.. _advancedgraphics:
Advanced Graphics
=================
Create your own Shader
----------------------
Rendering in a Framebuffer
--------------------------
Optimizations
-------------

View File

@ -0,0 +1,47 @@
.. _basic:
Basic Kivy
==========
Installation of Kivy environment
--------------------------------
Kivy depends on multiples dependencies, such as pygame, gstreamer, PIL, cairo,
and more. All of them are not required, but depending the platform you're
working on, it can be a pain to install them. For Windows and MacOSX, we
provide a portable package that you can just unzip and use.
.. toctree::
:maxdepth: 1
/installation/installation-windows.rst
/installation/installation-macosx.rst
/installation/installation-linux.rst
If you want to install everything yourself, ensure that you have at least
`Cython <http://cython.org>`_, `Pygame <http://pygame.org>`. A typical pip
installation look like::
pip install cython
pip install hg+http://bitbucket.org/pygame/pygame
pip install kivy
The `development version <https://github.com/kivy/kivy>`_ can be installed with
git::
git clone https://github.com/kivy/kivy
make
Create an application
---------------------
Running the application
-----------------------
Customize the application
-------------------------
Platform specifics
------------------

View File

@ -0,0 +1,17 @@
.. _bestpractices:
Best Practices
==============
Designing your Application code
-------------------------------
Handle Window resizing
----------------------
Managing resources
------------------
Platform consideration
----------------------

View File

@ -0,0 +1,23 @@
.. _events:
.. _properties:
Events and Properties
=====================
Introduction to Event Dispatcher
--------------------------------
Creating custom events
----------------------
Attaching callbacks
-------------------
Introduction to properties
--------------------------
Declaration of a Property
-------------------------
Dispatching a Property event
----------------------------

View File

@ -0,0 +1,17 @@
.. _graphics:
Graphics
========
Introduction to Canvas
----------------------
Context instructions
--------------------
Drawing instructions
--------------------
Manipulating instructions
-------------------------

View File

@ -0,0 +1,19 @@
.. _lang:
Kv language
===========
Concept behind the language
---------------------------
Rule context
------------
Instanciate children
--------------------
Extend canvas
-------------
Templating
----------

View File

@ -0,0 +1,2 @@
Packaging
=========

View File

@ -0,0 +1,17 @@
.. _widgets:
Widgets
=======
Introduction to Widget
----------------------
Manipulating the Widget tree
----------------------------
Organize with Layouts
---------------------
Seperate with Screen Manager
----------------------------