diff --git a/doc/sources/faq.rst b/doc/sources/faq.rst new file mode 100644 index 000000000..5246d8264 --- /dev/null +++ b/doc/sources/faq.rst @@ -0,0 +1,61 @@ +Frequently Asked Questions +========================== + +Does Kivy support Python 3.x? + No. Not yet. Python 3 is certainly a good thing; However, it broke + backwards compatibility (for good reasons) which means that some + considerable portion of available Python projects do not yet work + with Python 3. This also applies to some of the projects that Kivy can + use as a dependency, which is why we didn't make the switch yet. + We would also need to switch our own codebase to Python 3. We didn't + do that yet because it's not very high on our priority list, but if + somebody doesn't want to wait for us doing it, please go ahead. + Please note, though, that Python 2.x is still the de facto standard. + + +How is Kivy related to PyMT? + Our developers are professionals and are pretty savvy in their + area of expertise. However, before Kivy came around there was (and + still is) a project named PyMT that was led by our core developers. + We learned a great deal from that project during the time that we + developed it. In the more than two years of research and development + we found many interesting ways on how to improve the design of our + framework. We have done numerous benchmarks and as it turns out, to + achieve the great speed and flexibility that Kivy has, we had to + rewrite quite a big portion of the codebase, making this a + backwards-incompatible but future-proof decision. + Most notably are the performance increases, which are just incredible. + Kivy starts and operates just so much faster, due to heavy + optimizations. + We also had the opportunity to work with businesses and associations + using PyMT. We were able to test our product on a large diversity of + setups and made PyMT work on all of these. Writing a system such as + Kivy or PyMT is one thing. Making it work under all the different + conditions is another. We have a good background here, and brought our + knowledge to Kivy. + + Furthermore, since some of our core developers decided to stop their full-time + jobs and to turn to this project completely, it was decided that a more + professional foundation had to be laid. Kivy is that foundation. It is + supposed to be a stable and professional product. + Technically, Kivy is not really a successor to PyMT because there is + no easy migration path between them. However, the goal is the same: + Producing high-quality applications for novel user interfaces. + This is why we encourage everyone to base new projects on Kivy instead + of PyMT. + Active development of PyMT has stalled. Maintenance patches are still + accepted. + + +Do you accept patches? + Yes, we love patches. In order to ensure a smooth integration of your + precious changes, however, please make sure to read our contribution + guidelines. + Obviously we don't accept every patch. Your patch has to be coherent + with our styleguide and, more importantly, make sense. + It does make sense to talk to us before you come up with bigger + changes, especially new features. + + + + diff --git a/doc/sources/index.rst b/doc/sources/index.rst index d28e6e5a0..69dc7173c 100644 --- a/doc/sources/index.rst +++ b/doc/sources/index.rst @@ -6,13 +6,16 @@ development of applications equipped with novel user interfaces, such as multi-touch apps. You are probably wondering why you'd be interested in using Kivy. There is -a document outlining our :ref:`philosophy` we encourage you to read. +a document outlining our :res:`philosophy` we encourage you to read. We recommend that you get started with :ref:`installation` and then head over to the :ref:`quickstart` document. Besides the quickstart, there is also a more detailed :ref:`tutorial` that shows how to create an application with Kivy. +We also have a list of :ref:`frequently asked questions`. + .. include:: philosophy.rst +.. include:: faq.rst .. include:: guide-index.rst .. include:: api-index.rst diff --git a/doc/sources/philosophy.rst b/doc/sources/philosophy.rst index 61ad93744..a52565286 100644 --- a/doc/sources/philosophy.rst +++ b/doc/sources/philosophy.rst @@ -69,8 +69,8 @@ So what is it that makes Kivy special and worth using? with a few lines of code. Kivy programs are created by using the *Python* programming language, which is incredibly versatile, powerful yet easy to use. - In addition, we created our own description language - for creating sophisticated user interfaces. This + In addition, we created our own description language, + the *Kivy Language*, for creating sophisticated user interfaces. This language allows you to set up, connect and arrange your application elements quickly. We feel that allowing you to focus on the essence of