diff --git a/doc/sources/guide/quickstart.rst b/doc/sources/guide/quickstart.rst index adda58c60..7cff6689b 100644 --- a/doc/sources/guide/quickstart.rst +++ b/doc/sources/guide/quickstart.rst @@ -44,14 +44,14 @@ Now, to run your application, depending of your platform, you can : # or C:\appdir>kivy.bat main.py - MacOSX + Mac OS X Follow the instructions for :ref:`running Kivy application on MacOSX `:: $ kivy main.py Android - You application need some complementary files to be able to run on Android. - See :doc:`android` for more informations. + Your application needs some complementary files to be able to run on Android. + See :doc:`android` for further reference. A window should open, showing a sole button (with the label 'Hello World') that covers the entire window's area. That's all there is to it. diff --git a/doc/sources/installation/installation-ubuntu.rst b/doc/sources/installation/installation-ubuntu.rst index 23b40c584..ea5dc09f3 100644 --- a/doc/sources/installation/installation-ubuntu.rst +++ b/doc/sources/installation/installation-ubuntu.rst @@ -1,9 +1,16 @@ Installation on Ubuntu ====================== +The following instructions are for Ubuntu, but they should work in a +similar fashion for other Linux distributions (e.g. Debian, opensuse, +fedora, etc.). Obviously you will need to adjust the commands. + Ubuntu 10.10 (Maverick) ----------------------- +Unfortunately there is no kivy package in the Ubuntu repositories yet. +We're working on it. Until then, do the following instead: + :: $ sudo apt-get install python-setuptools python-pygame python-opengl \ diff --git a/doc/sources/installation/installation.rst b/doc/sources/installation/installation.rst index cc999d912..a476c60a5 100644 --- a/doc/sources/installation/installation.rst +++ b/doc/sources/installation/installation.rst @@ -9,8 +9,9 @@ existing, high-qualitative third-party libraries where possible. For the rich set of features that Kivy offers, several other libraries are required. If you do not use a specific feature (e.g. video playback) you don't need the corresponding dependency, however. -That said, there are one dependency that Kivy **does** require: +That said, there is one dependency that Kivy **does** require: `Cython `_. + In addition, you need a `Python `_ 2.x (**not** 3.x) interpreter. If you want to enable features like windowing (i.e., open a Window), audio/video playback or spelling correction, you must install other @@ -18,21 +19,30 @@ dependencies. For these, we recommend `Pygame `_, `Gst-Python `_ and `Enchant `_, respectively. -Other optional libraries (mutually interchangable) are: +Other optional libraries (mutually interchangeable) are: - * `OpenCV 2.0 `_: Camera input. - * `PIL `_: Image and text display. - * `PyCairo `_: Text display. - * `PyEnchant `_: Spelling correction. - * `Pygame `_ : Window creation, image and text display, audio playback. - * `PyGST `_: Audio/video playback and camera input. + * `OpenCV 2.0 `_ -- Camera input. + * `PIL `_ -- Image and text display. + * `PyCairo `_ -- Text display. + * `PyEnchant `_ -- Spelling correction. + * `Pygame `_ -- Window creation, image and text display, audio playback. + * `PyGST `_ -- Audio/video playback and camera input. -Stable version +That said, **DON'T PANIC**! + +We don't ask you to install all those things on your own. +Instead, we created nice portable packages that you can use directly +since they already contain the necessary packages for your platform. +We just want you to know about the alternatives for the defaults and give +you an overview about the things Kivy uses internally. + + +Stable Version -------------- The latest stable version can be found on the Kivy's website at http://kivy.org/#downloads -Select the installations instructions for your platform: +Please refer to the installation instructions for your specific platform: .. toctree:: :maxdepth: 1 @@ -86,11 +96,11 @@ download and compile a development version of Kivy:: $ python setup.py build_ext --inplace -f If you have the ``make`` command available, you can also use the -following shortcut to compile (does the same as the last two commands):: +following shortcut to compile (does the same as the last command):: - $ make build + $ make -If you want to modify the Kivy codebase itself, +If you want to modify the Kivy code itself, set up the `PYTHONPATH environment variable `_ to point at your clone. This way you don't have to install (``setup.py install``) after every tiny @@ -102,4 +112,4 @@ Or, if you don't want to make any changes to Kivy itself, you can also run $ python setup.py install If you want to contribute code (patches, new features) to the Kivy -codebase, please read :ref:`contributing`. +code base, please read :ref:`contributing`.