doc: push installation instructions for windows / macosx / ubuntu

This commit is contained in:
Mathieu Virbel 2011-02-01 11:24:24 +01:00
parent a7297773f7
commit 8a7d22a918
4 changed files with 147 additions and 3 deletions

View File

@ -0,0 +1,43 @@
Installation on MacOSX
======================
.. note::
This method has only been tested on Mac OSX 10.6 Snow Leopard 64-bit.
For versions prior to 10.6 or 10.6 32-bit, you have to install the
components yourself. We suggest using
`homebrew <http://mxcl.github.com/homebrew/>`_ to do that.
For Mac OS X 10.6 and later, we provide a Kivy.app with all dependencies
bundled. Download it from our google code project page. It comes as a .dmg
file that contains:
* Kivy.app
* Readme.txt
* An Examples folder
* A script to install a `kivy` command for shell usage
To install Kivy, you must do:
1. Download the latest version from http://kivy.org/#downloads
2. Double-click to open it
3. Drag the Kivy.app into your Applications folder
4. Make sure to read the Readme.txt
Start any Kivy's application
----------------------------
You can run any Kivy application by simply dragging the application's main file
onto the Kivy.app icon. Just try with any python file in the examples folder.
Start from commandline
----------------------
If you want to use Kivy from the command line, double-click the Make Symlinks script
after you dragged the Kivy.app into the Applications folder. To test if it worked:
1. open Terminal.app and run kivy. You will get a Python prompt.
2. In there, enter import kivy. Running any PyMT application from the command line
is now simply a matter of executing a command like the following:
3. kivy yourapplication.py

View File

@ -0,0 +1,21 @@
Installation on Ubuntu
======================
Ubuntu 10.10 (Maverick)
-----------------------
::
$ 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
$ easy_install kivy
If you already installed kivy before, you can upgrade it with::
$ easy_install -U kivy
You can know run any example from the examples directory of kivy.
$ cd <path to kivy directory>/examples/demo
$ python touchtracer.py

View File

@ -0,0 +1,74 @@
Installation on Windows
=======================
The windows stable version is what we call a portable package. You don't have
to install anything in "system" wide. Just unzip & run:
1. Download the latest version from http://kivy.org/#downloads
2. Unzip the package
3. Then, in the unzipped package, you have a script called `kivy.bat`,
use it for launching any kivy application
Start any Kivy's application
----------------------------
If you want to double-click and make it just "work", you need to use the
`kivy.bat` included in the package for starting Kivy application. To make
it work, do
1. Right click on the python file of the application
2. Open With
3. Select the default software
4. Browse your files to select the `kivy.bat`
5. Select "Always open the file with..." if you want
6. Ok !
Next time, your python file will be executed with the Kivy's python !
Start from commandline
----------------------
If you want just to use or develop with latest stable kivy, we offer you an
alternative way with a console. You need a minimalist GNU system installed on
your system. Use `msysGit <http://code.google.com/p/msysgit/>`_.
When you install the msysGit, you must select theses options:
* Don't replace windows shell
* Checkout at-is, commit at-is (no clrf replacement !)
You'll have an icon "Git bash" on your desktop, this is the console we want:
1. Start "Git bash"
2. cd "directory of portable kivy"
3. source kivyenv.sh "full directory of portable kivy" (don't use .)
You are now ready to launch python/kivy in commande line ! Just do::
python <filename.py>
Also, all other scripts and binary are available such as:
* cython
* gcc / make...
* easy_install
* gst-inspect-0.10
Content of the package
----------------------
The latest windows package contain:
* Latest kivy stable version
* Python 2.7.1
* Glew 1.5.7
* Pygame 1.9.2
* Cython 0.14
* MingW
* Gstreamer
* Setuptools

View File

@ -31,10 +31,16 @@ Other optional libraries (mutually interchangable) are:
Stable version
--------------
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.
The latest stable version can be found on the Kivy's website at http://kivy.org/#downloads
Select the installations instructions for your platform:
.. toctree::
:maxdepth: 1
installation-window.rst
installation-macosx.rst
installation-ubuntu.rst
installation-android.rst
Development Version
-------------------