mirror of https://github.com/kivy/kivy.git
update README
This commit is contained in:
Mathieu Virbel
parent
34f35ee991
commit
514e62b05c
|
|
@ -0,0 +1,85 @@
|
||||||
|
Kivy
|
||||||
|
====
|
||||||
|
|
||||||
|
Innovative User Interfaces Made Easy.
|
||||||
|
|
||||||
|
- Website: http://kivy.org/
|
||||||
|
- Documentation: http://kivy.org/docs/
|
||||||
|
|
||||||
|
[](https://coveralls.io/r/kivy/kivy?branch=master)
|
||||||
|
[](https://bitdeli.com/free)
|
||||||
|
|
||||||
|
|
||||||
|
Introduction
|
||||||
|
------------
|
||||||
|
|
||||||
|
Kivy is a Python library for development of multi-touch enabled media rich
|
||||||
|
applications. The aim is to allow for quick and easy interaction design and
|
||||||
|
rapid prototyping, while making your code reusable and deployable.
|
||||||
|
|
||||||
|
Kivy is written in Python and Cython, based on OpenGL ES 2, supports various
|
||||||
|
input devices and have an extensive widgets library. With the same codebase,
|
||||||
|
you can target Windows, OSX, Linux, Android and iOS. All our widgets are built
|
||||||
|
with multitouch support.
|
||||||
|
|
||||||
|
Kivy is MIT licensed, actively developed by a great community, as well as all
|
||||||
|
the projects managed by the Kivy organisation.
|
||||||
|
|
||||||
|
Installation, Documentation, Examples
|
||||||
|
-------------------------------------
|
||||||
|
|
||||||
|
Extensive installation instructions as well as tutorials and general
|
||||||
|
documentation, including an API reference can be found at: http://kivy.org/docs/
|
||||||
|
|
||||||
|
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
|
||||||
|
hardware such as Accelerometer, Camera,
|
||||||
|
- [Pyjnius](http://github.com/kivy/pyjnius): Access dynamically to Java/Android
|
||||||
|
API from Python, easy!
|
||||||
|
- [Pyobjus](http://github.com/kivy/pyobjus): Access dynamically to
|
||||||
|
Objective-C/iOS API from Python (wip)
|
||||||
|
- [Python for Android](http://github.com/kivy/python-for-android): Toolchain
|
||||||
|
for building and packaging Kivy application to Android APK.
|
||||||
|
- [Kivy iOS](http://github.com/kivy/kivy-ios): Toolchain for building and
|
||||||
|
packaging Kivy application to iOS IPA.
|
||||||
|
- [Audiostream](http://github.com/kivy/audiostream): Library to access directly
|
||||||
|
on the Microphone and Speaker, for iOS and Android.
|
||||||
|
- [Garden](http://github.com/kivy-garden): Explore the User's widgets libraries
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Licenses
|
||||||
|
--------
|
||||||
|
|
||||||
|
- Kivy is licensed under the terms of the MIT, check the LICENSE file.
|
||||||
|
- 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
|
||||||
|
- The current UI design has been adapted from Moblintouch theme's SVGs, licensed
|
||||||
|
under the terms of the LGPL 2.1.
|
||||||
|
|
||||||
|
|
||||||
85
README.rst
85
README.rst
|
|
@ -1,85 +0,0 @@
|
||||||
Kivy
|
|
||||||
====
|
|
||||||
|
|
||||||
Innovative User Interfaces Made Easy
|
|
||||||
http://kivy.org/
|
|
||||||
|
|
||||||
|
|
||||||
.. image:: https://coveralls.io/repos/kivy/kivy/badge.png?branch=master
|
|
||||||
:target: https://coveralls.io/r/kivy/kivy?branch=master
|
|
||||||
|
|
||||||
|
|
||||||
Introduction
|
|
||||||
------------
|
|
||||||
|
|
||||||
Kivy is a Python library for development of multi-touch enabled media rich
|
|
||||||
applications. The aim is to allow for quick and easy interaction design and
|
|
||||||
rapid prototyping, while making your code reusable and deployable.
|
|
||||||
|
|
||||||
Kivy is written in Python, based on OpenGL and supports different input devices
|
|
||||||
such as: Mouse, Dual Mouse, TUIO, WiiMote, WM_TOUCH, HIDtouch, Apple's products
|
|
||||||
and so on.
|
|
||||||
|
|
||||||
Kivy is actively being developed by a community and free to use. It operates on
|
|
||||||
all major platforms (Linux, OSX, Windows, Android).
|
|
||||||
|
|
||||||
/!\ The main resource for information is the website: http://kivy.org
|
|
||||||
|
|
||||||
|
|
||||||
Installation, Documentation, Examples
|
|
||||||
-------------------------------------
|
|
||||||
|
|
||||||
Extensive installation instructions as well as tutorials and general
|
|
||||||
documentation, including an API reference can be found at:
|
|
||||||
|
|
||||||
http://kivy.org/docs/
|
|
||||||
|
|
||||||
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-dev
|
|
||||||
* Email : kivy-dev@googlegroups.com
|
|
||||||
|
|
||||||
We also have an IRC channel (expect responses mostly in the day hours of CET):
|
|
||||||
|
|
||||||
* Server : irc.freenode.net
|
|
||||||
* Channel : #kivy
|
|
||||||
|
|
||||||
|
|
||||||
Other Python/MT resources
|
|
||||||
-------------------------
|
|
||||||
|
|
||||||
movid.org
|
|
||||||
^^^^^^^^^
|
|
||||||
|
|
||||||
Another vision tracking system we are working on. Can be used to give life to
|
|
||||||
DIY multitouch hardware.
|
|
||||||
|
|
||||||
nuigroup.com
|
|
||||||
^^^^^^^^^^^^
|
|
||||||
|
|
||||||
THE resource and research community for open source multi touch and other
|
|
||||||
natural user interfaces.
|
|
||||||
|
|
||||||
|
|
||||||
Licenses
|
|
||||||
--------
|
|
||||||
|
|
||||||
- Kivy is licensed under the terms of the MIT, check the LICENSE file.
|
|
||||||
- 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
|
|
||||||
- The current UI design has been adapted from Moblintouch theme's SVGs, licensed
|
|
||||||
under the terms of the LGPL 2.1.
|
|
||||||
|
|
||||||
|
|
||||||
.. image:: https://d2weczhvl823v0.cloudfront.net/kivy/kivy/trend.png
|
|
||||||
:alt: Bitdeli badge
|
|
||||||
:target: https://bitdeli.com/free
|
|
||||||
|
|
||||||
Loading…
Reference in New Issue