diff --git a/doc/sources/guide/installation-macosx.rst b/doc/sources/guide/installation-macosx.rst new file mode 100644 index 000000000..ff75b4e0b --- /dev/null +++ b/doc/sources/guide/installation-macosx.rst @@ -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 `_ 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 + diff --git a/doc/sources/guide/installation-ubuntu.rst b/doc/sources/guide/installation-ubuntu.rst new file mode 100644 index 000000000..569133460 --- /dev/null +++ b/doc/sources/guide/installation-ubuntu.rst @@ -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 /examples/demo + $ python touchtracer.py + diff --git a/doc/sources/guide/installation-window.rst b/doc/sources/guide/installation-window.rst new file mode 100644 index 000000000..36654626e --- /dev/null +++ b/doc/sources/guide/installation-window.rst @@ -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 `_. + +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 + +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 + + diff --git a/doc/sources/guide/installation.rst b/doc/sources/guide/installation.rst index 7d10693f9..b4395785c 100644 --- a/doc/sources/guide/installation.rst +++ b/doc/sources/guide/installation.rst @@ -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 -------------------