diff --git a/doc/sources/installation/installation-osx.rst b/doc/sources/installation/installation-osx.rst index c9ff2f499..f19ada5ba 100644 --- a/doc/sources/installation/installation-osx.rst +++ b/doc/sources/installation/installation-osx.rst @@ -1,7 +1,68 @@ .. _installation_osx: Installation on OS X -====================== +==================== + +.. note:: + + This guide describes multiple ways for setting up Kivy. Installing + with Homebrew and pip is recommended for general use. + +Using Homebrew with pip +----------------------- + +You can install Kivy with Homebrew and pip using the following steps: + + 1. Install the requirements using `homebrew `_:: + + $ brew install sdl2 sdl2_image sdl2_ttf sdl2_mixer gstreamer + + 2. Install cython 0.23 and kivy using pip + (make sure to set the env variable USE_OSX_FRAMEWORKS=0, command varies by shell):: + + $ pip install -I Cython==0.23 + $ USE_OSX_FRAMEWORKS=0 pip install kivy + + - To install the development version, use this in the second step:: + + $ USE_OSX_FRAMEWORKS=0 pip install https://github.com/kivy/kivy/archive/master.zip + +Using MacPorts with pip +----------------------- + +.. note:: + + You will have to manually install gstreamer support if you wish to + support video playback in your Kivy App. The latest port documents show the + following `py-gst-python port `_. + +You can install Kivy with Macports and pip using the following steps: + + 1. Install `Macports `_ + + 2. Install and set Python 3.4 as the default:: + + $ port install python34 + $ port select --set python python34 + + 3. Install and set pip as the default:: + + $ port install pip-34 + $ port select --set pip pip-34 + + 4. Install the requirements using `Macports `_:: + + $ port install libsdl2 libsdl2_image libsdl2_ttf libsdl2_mixer + + 5. Install cython 0.23 and kivy using pip + (make sure to set the env variable USE_OSX_FRAMEWORKS=0, command varies by shell):: + + $ pip install -I Cython==0.23 + $ USE_OSX_FRAMEWORKS=0 pip install kivy + + - To install the development version, use this in the second step:: + + $ USE_OSX_FRAMEWORKS=0 pip install https://github.com/kivy/kivy/archive/master.zip Using The Kivy.app ------------------ @@ -13,9 +74,12 @@ Using The Kivy.app components yourself. We suggest using `homebrew `_ to do that. -For OS X 10.7 and later, we provide a Kivy.app with all dependencies -bundled. Download it from our `Download Page `_. -It comes as a .7z file that contains: +For OS X 10.7 and later, we provide packages with all dependencies +bundled in a virtual environment, including a Python interpreter for +Kivy3.app. These bundles are primarily used for rapid prototyping, +and currently serve as containers for packaging Kivy apps with Buildozer. +Download them from our `Download Page `_. +They come as .7z files which contain: * Kivy.app @@ -117,61 +181,3 @@ after you have dragged the Kivy.app into the Applications folder. To test if it of executing a command like the following:: $ kivy yourapplication.py - - -Using Homebrew with pip ------------------------ - -You can install Kivy with Homebrew and pip using the following steps: - - 1. Install the requirements using `homebrew `_:: - - $ brew install sdl2 sdl2_image sdl2_ttf sdl2_mixer gstreamer - - 2. Install cython 0.23 and kivy using pip - (make sure to set the env variable USE_OSX_FRAMEWORKS=0, command varies by shell):: - - $ pip install -I Cython==0.23 - $ USE_OSX_FRAMEWORKS=0 pip install kivy - - - To install the development version, use this in the second step:: - - $ USE_OSX_FRAMEWORKS=0 pip install https://github.com/kivy/kivy/archive/master.zip - -Using MacPorts with pip ------------------------ - -.. note:: - - You will have to manually install gstreamer support if you wish to - support video playback in your Kivy App. The latest port documents show the - following `py-gst-python port `_. - -You can install Kivy with Macports and pip using the following steps: - - 1. Install `Macports `_ - - 2. Install and set Python 3.4 as the default:: - - $ port install python34 - $ port select --set python python34 - - 3. Install and set pip as the default:: - - $ port install pip-34 - $ port select --set pip pip-34 - - 4. Install the requirements using `Macports `_:: - - $ port install libsdl2 libsdl2_image libsdl2_ttf libsdl2_mixer - - 5. Install cython 0.23 and kivy using pip - (make sure to set the env variable USE_OSX_FRAMEWORKS=0, command varies by shell):: - - $ pip install -I Cython==0.23 - $ USE_OSX_FRAMEWORKS=0 pip install kivy - - - To install the development version, use this in the second step:: - - $ USE_OSX_FRAMEWORKS=0 pip install https://github.com/kivy/kivy/archive/master.zip -