Skip to content
Browse files

docs: Add Licensing info, reword windows installation and some furthe…

…r fixes and optimizations
  • Loading branch information...
1 parent 82e875a commit 70e4b430fc242407820295fca685dbef932898e3 @dennda dennda committed Mar 16, 2011
View
10 AUTHORS
@@ -1,12 +1,12 @@
-Authors of KIVY Toolkit
-=======================
+Authors & Contributors of the Kivy Toolkit
+==========================================
-Maintainers
------------
+Authors & Maintainers
+---------------------
* Mathieu Virbel <tito __at__ bankiz.org>
* Thomas Hansen (University of Iowa) <thomas.hansen __at__ gmail.com>
- * Christopher Denter <dennda __at__ the-space-station.com>
+ * Christopher Denter <christopher __at__ kivy.org>
Contributors
View
14 doc/sources/contribute.rst
@@ -24,7 +24,7 @@ feel encouraged to report any obstacles you encountered such as missing
documentation, misleading directions or similar.
We are perfectionists, so even if it's just a typo, let us know.
-Reporting an issue
+Reporting an Issue
------------------
If you found anything wrong, a crash, segfault, missing documentation, invalid
@@ -105,7 +105,7 @@ Now, whenever you want to create a patch, you follow the following steps:
whether you have introduced some weird bug without testing.
#. Do one or more minimal, atomic commits per fix or per feature.
Minimal/Atomic means *keep the commit clean*. Don't commit other stuff that
- doesn't logically belong to this fix or feature. This is NOT about
+ doesn't logically belong to this fix or feature. This is **not** about
creating one commit per line changed. Use ``git add -p`` if necessary.
#. Give each commit an appropriate commit message, so that others who are
not familiar with the matter get a good idea of what you changed.
@@ -117,11 +117,11 @@ Now, whenever you want to create a patch, you follow the following steps:
in the GitHub interface of your repository. (This is why we forked
initially. Your repository is linked against ours.)
- **Note:**
- When you change parts of the code base that require compilation, you
- will have to recompile in order for your changes to take effect. The ``make
- build`` command will do that for you (see the Makefile if you want to execute
- the steps manually). If you need to clean your current directory from compiled
+ .. warning::
+ If you change parts of the code base that require compilation, you
+ will have to recompile in order for your changes to take effect. The ``make``
+ command will do that for you (see the Makefile if you want to know
+ what it does). If you need to clean your current directory from compiled
files, execute ``make clean``. If you want to get rid of **all** files that are
not under version control, run ``make distclean``
(**Caution:** If your changes are not under version control, this
View
26 doc/sources/index.rst
@@ -23,6 +23,28 @@ concern isn't addressed in the documentation, feel free to :ref:`contact`.
Appendix
========
-The appendix contains an enumeration of all the different module, class,
-function and variable names available in Kivy.
+The appendix contains licensing information and an enumeration of all the
+different module, class, function and variable names available in Kivy.
+
+License
+-------
+
+Kivy is released under the terms of the GNU LGPL Version 3.
+You should have received a copy of the LGPL alongside your Kivy
+distribution. See the file COPYING in the Kivy root folder.
+An online version of the license can be found at
+http://www.gnu.org/licenses/lgpl-3.0.txt
+
+In a nutshell the license allows you to use Kivy in your own projects,
+regardless if they are open source, closed source, commercial or free.
+The one thing the license does enforce is that if you make changes to the
+Kivy sourcecode **itself**, you have to share those changes with us.
+For a more thorough legal explanation of the terms and conditions, please
+refer to the documents listed above.
+
+For a list of authors, please see the file AUTHORS that accompanies the
+Kivy source code distribution (next to COPYING).
+
+
+Kivy -- Copyright 2011, The Kivy Authors. All rights reserved.
View
78 doc/sources/installation/installation-windows.rst
@@ -1,70 +1,81 @@
Installation on Windows
=======================
-The windows stable version is what we call a portable package. You don't have
-to install anything in "system" wide. Just unzip & run:
+For Windows, we provide what we call a 'portable package'. You don't have
+to install anything "system" wide. Just unzip & run:
- 1. Download the latest version from http://kivy.org/#downloads
- 2. Unzip the package
- 3. Then, in the unzipped package, you have a script called `kivy.bat`,
- use it for launching any kivy application
+ #. Download the latest version from http://kivy.org/#downloads
+ #. Unzip the package
+ #. Then, in the unzipped package, you have a script called `kivy.bat`,
+ use it for launching any kivy application as described below
.. _windows-run-app:
-Start any Kivy's application
-----------------------------
+Start a Kivy Application
+------------------------
-If you want to double-click and make it just "work", you need to use the
-`kivy.bat` included in the package for starting Kivy application. To make
-it work, do
+There are some simple steps that you need to do once in order to be able
+to launch any kivy application by just double-clicking it:
- 1. Right click on the python file of the application
- 2. Open With
- 3. Select the default software
- 4. Browse your files to select the `kivy.bat`
- 5. Select "Always open the file with..." if you want
- 6. Ok !
+ #. Right click on the main python file (.py ending) of the application you want to launch
+ #. From the context menu that appears, select *Open With*
+ #. Browse your hard disk drive and find the file ``kivy.bat`` from the portable package. Select it.
+ #. Select "Always open the file with..." if you don't want to repeat this procedure every time you double click a .py file.
+ #. You are done. Open the file.
-Next time, your python file will be executed with the Kivy's python !
+The next time you double click a .py file, it will be executed with the version
+of python that Kivy ships with.
+.. note::
+ On Windows we have to ship our own version of Python since it's not
+ installed by default on Windows (unlike Mac OS X and Linux). By
+ following the steps above, you will set Kivy's version of Python as the
+ default for opening .py files for your user.
+ Normally this should not be harmful as it's just a normal version of
+ Python with the :ref:`necessary third party libraries <winpackagecontents>`
+ added to the module search path.
+ If you do encounter unexpected problems, please :ref:`contact`.
-Start from commandline
-----------------------
-If you want just to use or develop with latest stable kivy, we offer you an
-alternative way with a console. You need a minimalist GNU system installed on
+Start from Command-Line
+-----------------------
+
+If you just want to use or develop with the latest stable kivy version, we offer
+an alternative way with a console. You need a minimalist GNU system installed on
your system. Use `msysGit <http://code.google.com/p/msysgit/>`_.
-When you install the msysGit, you must select theses options:
+When you install msysGit, you must select theses options:
* Don't replace windows shell
- * Checkout at-is, commit at-is (no clrf replacement !)
+ * Checkout as-is, commit as-is (no CLRF replacement!)
You'll have an icon "Git bash" on your desktop, this is the console we want:
- 1. Start "Git bash"
- 2. cd "directory of portable kivy"
- 3. source kivyenv.sh "full directory of portable kivy" (don't use .)
+ #. Start "Git bash"
+ #. ``cd <directory of portable kivy>``
+ #. ``source kivyenv.sh <full directory path of portable kivy>`` # (don't use .)
-You are now ready to launch python/kivy in commande line ! Just do::
+You are now ready to launch python/kivy from the command-line! Just do::
python <filename.py>
-Also, all other scripts and binary are available such as:
+Also, all other scripts and binaries are available, such as:
* cython
* gcc / make...
* easy_install
* gst-inspect-0.10
-Content of the package
-----------------------
+.. _winpackagecontents:
+
+Package Contents
+----------------
-The latest windows package contain:
+The latest Windows package contains:
- * Latest kivy stable version
+ * Latest stable kivy version
* Python 2.7.1
* Glew 1.5.7
* Pygame 1.9.2
@@ -73,4 +84,3 @@ The latest windows package contain:
* Gstreamer
* Setuptools
-
View
9 doc/sources/installation/installation.rst
@@ -14,8 +14,8 @@ That said, there is one dependency that Kivy **does** require:
In addition, you need a `Python <http://python.org/>`_ 2.x (**not** 3.x)
interpreter. If you want to enable features like windowing (i.e., open a Window),
-audio/video playback or spelling correction, you must install other
-dependencies. For these, we recommend `Pygame <http://pygame.org>`_, `Gst-Python
+audio/video playback or spelling correction, additional dependencies must
+be available. For these, we recommend `Pygame <http://pygame.org>`_, `Gst-Python
<http://www.gstreamer.net/modules/gst-python.html>`_ and `Enchant
<http://www.rfk.id.au/software/pyenchant/>`_, respectively.
@@ -41,17 +41,18 @@ you an overview about the things Kivy uses internally.
Stable Version
--------------
-The latest stable version can be found on the Kivy's website at http://kivy.org/#downloads
+The latest stable version can be found on Kivy's website at http://kivy.org/#downloads
Please refer to the installation instructions for your specific platform:
.. toctree::
- :maxdepth: 1
+ :maxdepth: 2
installation-windows
installation-macosx
installation-ubuntu
installation-android
+
Development Version
-------------------

0 comments on commit 70e4b43

Please sign in to comment.
Something went wrong with that request. Please try again.