Link install guide and contribution guide for developers

This commit is contained in:
Christopher Denter 2011-01-30 13:43:20 +01:00
parent 1ab473c6b4
commit f72b806597
2 changed files with 39 additions and 13 deletions

View File

@ -41,8 +41,8 @@ base. If you don't want to use GitHub, we assume you know what you do anyway.
Code Workflow
~~~~~~~~~~~~~
So here is the initial setup to begin with our workflow (You only need to do
this once):
So here is the initial setup to begin with our workflow (you only need to do
this once to install Kivy):
#. Log in to GitHub
#. Create a fork of the `Kivy repository <https://github.com/tito/kivy>`_ by
@ -55,7 +55,7 @@ this once):
the parts that you changed, your commit will be aborted. Fix & retry.
#. Set up the `PYTHONPATH environment variable <http://docs.python.org/tutorial/modules.html#the-module-search-path>`_
to point at your clone.
This way you don't have to install (``setup.py install``) after every tine
This way you don't have to install (``setup.py install``) after every tiny
modification. Python will instead import Kivy from your clone.
Now, whenever you want to create a patch, you follow the following steps:
@ -83,6 +83,16 @@ Now, whenever you want to create a patch, you follow the following steps:
in the GitHub interface of your repository. (This is why we forked
initially. Your repository is linked against ours.)
**Note:**
When you change parts of the code base that require compilation, you
will have to recompile in order for your changes to take effect. The ``make
build`` command will do that for you (see the Makefile if you want to execute
the steps manually). If you need to clean your current directory from compiled
files, execute ``make clean``. If you want to get rid of **all** files that are
not under version control, run ``make distclean``
(**Caution:** If your changes are not under version control, this
command will delete them!)
Now we will receive your pull request. We will check whether your changes are
clean and make sense (if you talked to us before doing all of this we will have
told you whether it makes sense or not). If so, we will pull them and you will

View File

@ -31,27 +31,43 @@ Other optional libraries (mutually interchangable) are:
Stable version
--------------
No stable version yet.
No stable version yet. Please be patient. Once we release a stable
version, we will provide packages for every supported platform that allow
you to simply download and run Kivy applications.
Development version
Development Version
-------------------
If you want to work with the latest version of Kivy, you must clone and use our source code repository from `Github <https://github.com/tito/kivy/>`_.
The development version is for developers and testers. Note that when
running a development version, you're running potentially broken code at
your own risk.
To use the development version, you will first need to install the
dependencies. Afterwards you have to set up Kivy on your computer in a way
that allows for easy development. For that, please see our
:ref:`contributing` document.
Installing Dependencies
~~~~~~~~~~~~~~~~~~~~~~~
To install Kivy's dependencies, follow the guide below for your platform.
Ubuntu
~~~~~~
++++++
For Ubuntu, simply enter the following command that will install all
necessary packages:
::
$ sudo apt-get install python-setuptools python-pygame python-opengl \
python-gst0.10 python-enchant gstreamer0.10-plugins-good cython python-dev \
build-essential libgl1-mesa-dev libgles2-mesa-dev
$ git clone git://github.com/tito/kivy.git
$ cd kivy
$ python setup.py build_ext --inplace
$ python setup.py build_factory
Then, add in your environment ::
$ export PYTHONPATH=~/path/of/kivy/clone
Installing Kivy
~~~~~~~~~~~~~~~
In order to set up Kivy for development, please set up a development
environment for Kivy on your computer. Follow the steps mentioned in
:ref:`contributing`.