kivy/README.md

87 lines
3.2 KiB
Markdown
Raw Normal View History

2014-02-13 12:30:11 +00:00
[![Stories in Ready](https://badge.waffle.io/kivy/kivy.png?label=ready)](https://waffle.io/kivy/kivy)
2014-01-11 15:42:56 +00:00
Kivy
====
Innovative User Interfaces Made Easy.
- Website: http://kivy.org/
- Documentation: http://kivy.org/docs/
[![Kivy's Coverage](https://coveralls.io/repos/kivy/kivy/badge.png?branch=master)](https://coveralls.io/r/kivy/kivy?branch=master)
[![Kivy's Trending](https://d2weczhvl823v0.cloudfront.net/kivy/kivy/trend.png)](https://bitdeli.com/free)
Introduction
------------
2014-03-01 06:20:20 +00:00
Kivy is a Python framework for the development of multi-touch enabled media rich
2014-01-11 15:42:56 +00:00
applications. The aim is to allow for quick and easy interaction design and
2014-03-01 06:20:20 +00:00
rapid prototyping whilst making your code reusable and deployable.
2014-01-11 15:42:56 +00:00
Kivy is written in Python and Cython, based on OpenGL ES 2, supports various
2014-03-01 06:20:20 +00:00
input devices and has an extensive widget library. With the same codebase,
2014-01-11 15:42:56 +00:00
you can target Windows, OSX, Linux, Android and iOS. All our widgets are built
with multitouch support.
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
Installation, Documentation, Examples
-------------------------------------
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:
* Google Group : http://groups.google.com/group/kivy-users
* Email : kivy-users@googlegroups.com
We also have an IRC channel (expect responses mostly in the day hours of CET):
* Server : irc.freenode.net
* Channel : #kivy
Others projects
---------------
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-03-01 06:20:20 +00:00
- [Pyobjus](http://github.com/kivy/pyobjus): Dynamic acccess 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-03-05 21:53:06 +00:00
- Kivy is licensed under the terms of the MIT. Please refer to the LICENSE file.
2014-01-11 15:42:56 +00:00
- The provided fonts DroidSans.ttf and DroidSansMono.ttf are licensed under
the terms of the Apache 2.0 License. The license can be found at
http://www.apache.org/licenses/LICENSE-2.0
2014-03-05 21:53:06 +00:00
- The current UI design has been adapted from Moblintouch theme's SVGs and is
licensed under the terms of the LGPL 2.1.
2014-01-11 15:42:56 +00:00