kivy/README.md

102 lines
3.8 KiB
Markdown
Raw Normal View History

2014-01-11 15:42:56 +00:00
Kivy
====
2014-05-03 14:23:30 +00:00
<img align="right" height="256" src="https://raw.githubusercontent.com/kivy/kivy/master/kivy/data/logo/kivy-icon-256.png"/>
2014-01-11 15:42:56 +00:00
2014-05-03 14:23:30 +00:00
Innovative User Interfaces Made Easy.
2014-01-11 15:42:56 +00:00
2014-05-03 14:23:30 +00:00
Kivy is a [Python](https://www.python.org) framework for the development of
multi-touch enabled media rich applications. The aim is to allow for quick and
easy interaction design and rapid prototyping whilst making your code reusable
and deployable.
2014-01-11 15:42:56 +00:00
2014-05-03 14:23:30 +00:00
Kivy is written in Python and [Cython](http://cython.org/), based on OpenGL ES
2, supports various input devices and has an extensive widget library. With the
same codebase, you can target Windows, OSX, Linux, Android and iOS. All our
widgets are built with multitouch support.
2014-01-11 15:42:56 +00:00
2014-03-01 06:20:20 +00:00
Kivy is MIT licensed, actively developed by a great community and is supported
by many projects managed by the Kivy organisation.
2014-01-11 15:42:56 +00:00
[![Kivy's Coverage](https://coveralls.io/repos/kivy/kivy/badge.png?branch=master)](https://coveralls.io/r/kivy/kivy?branch=master) [![Bountysource](https://www.bountysource.com/badge/tracker?tracker_id=42681)](https://www.bountysource.com/trackers/42681-kivy?utm_source=42681&utm_medium=shield&utm_campaign=TRACKER_BADGE)
2014-05-03 14:23:30 +00:00
2015-01-12 21:52:26 +00:00
Installation, Documentation and Examples
----------------------------------------
2014-01-11 15:42:56 +00:00
Extensive installation instructions as well as tutorials and general
2014-03-01 06:20:20 +00:00
documentation, including an API reference, can be found at: http://kivy.org/docs/
2014-01-11 15:42:56 +00:00
An offline version in PDF format is also available.
Kivy ships with a bunch of examples that can be found in the examples/ folder.
Support
-------
If you need assistance, you can ask for help on our mailing list:
2014-06-11 17:24:11 +00:00
* User Group : https://groups.google.com/group/kivy-users
* Email : kivy-users@googlegroups.com
2014-01-11 15:42:56 +00:00
2014-10-08 14:49:51 +00:00
We also have an IRC channel:
2014-01-11 15:42:56 +00:00
* Server : irc.freenode.net
2014-06-11 17:24:11 +00:00
* Port : 6667, 6697 (SSL only)
2014-01-11 15:42:56 +00:00
* Channel : #kivy
2015-01-12 21:52:26 +00:00
Contributing
------------
2014-06-11 17:24:11 +00:00
We love pull requests and discussing novel ideas. Check out our
contribution guide (http://kivy.org/docs/contribute.html) and
feel free to improve Kivy.
2015-01-12 21:52:26 +00:00
The following mailing list and IRC channel are used exclusively for
2014-06-11 17:24:11 +00:00
discussions about developing the Kivy framework and its sister projects:
* Dev Group : https://groups.google.com/group/kivy-dev
* Email : kivy-dev@googlegroups.com
2014-10-08 14:49:51 +00:00
IRC channel:
2014-06-11 17:24:11 +00:00
* Server : irc.freenode.net
* Port : 6667, 6697 (SSL only)
* Channel : #kivy-dev
2014-04-24 02:27:33 +00:00
Other projects
2014-01-11 15:42:56 +00:00
---------------
Have a look at our complementary projects:
- [Buildozer](http://github.com/kivy/buildozer): A robot that will do
everything needed to package your application for iOS and Android. Ask him,
wait, it's done.
- [Plyer](http://github.com/kivy/plyer): Library for accessing features of your
2014-03-05 21:53:06 +00:00
hardware such as the Accelerometer, Camera etc.
2014-03-01 06:20:20 +00:00
- [Pyjnius](http://github.com/kivy/pyjnius): Dynamic access to the Java/Android
2014-03-05 21:53:06 +00:00
API from Python? Easy!
2014-04-24 02:27:33 +00:00
- [Pyobjus](http://github.com/kivy/pyobjus): Dynamic access to the
2014-03-05 21:53:06 +00:00
Objective-C/iOS API from Python (wip).
2014-01-11 15:42:56 +00:00
- [Python for Android](http://github.com/kivy/python-for-android): Toolchain
2014-03-01 06:20:20 +00:00
for building and packaging Kivy applications into Android APK's.
2014-01-11 15:42:56 +00:00
- [Kivy iOS](http://github.com/kivy/kivy-ios): Toolchain for building and
2014-03-01 06:20:20 +00:00
packaging Kivy applications into iOS IPA's.
- [Audiostream](http://github.com/kivy/audiostream): Library for direct access
2014-03-05 21:53:06 +00:00
to the Microphone and Speaker (for iOS and Android).
2014-03-01 06:20:20 +00:00
- [Garden](http://github.com/kivy-garden): Explore User's widgets and libraries
2014-01-11 15:42:56 +00:00
Licenses
--------
2014-04-24 02:27:33 +00:00
- Kivy is released under the terms of the MIT License. Please refer to the
LICENSE file.
- The provided fonts DroidSans.ttf and DroidSansMono.ttf are licensed and
2014-04-24 02:27:33 +00:00
distributed under the terms of the
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
- The current UI design has been adapted from Moblintouch theme's SVGs
and is licensed under the terms of the
[LGPLv2.1](http://www.gnu.org/licenses/old-licenses/lgpl-2.1).
2014-01-11 15:42:56 +00:00