jepler/gltools
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update docs

Browse source
This commit is contained in:
Runar Tenfjord 2012-11-24 20:55:06 +01:00
parent 8d1f142d30
commit 7d29e3b81b
3 changed files with 39 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Makefile
View file

@ -29,7 +29,6 @@ sdist: clean
clean:
-rm -rf build dist
-rm -rf gltools/@docs/build
-rm -rf gltools/@docs/html
-rm gltools/@src/Config.pxi
-rm gltools/gltools.cpp gltools.so gltools/gltools.so MANIFEST
-find gltools -iname '*.so' -exec rm {} \;

6
README.rst
View file

@ -27,7 +27,7 @@ Building
Prebuild installers are available on the pypi_ site
for the Windows platform.
For Linux build scripts are available for ArchLinux in the AUR
For Linux build scripts are available for ArchLinux in the AUR_
repository. These could be adapted to other Linux distros.
Note that currently I can not find a way to install the required
@ -50,4 +50,6 @@ See online Sphinx docs_
.. _GLFW: http://github.com/elmindreda/glfw
.. _pypi: http://pypi.python.org/pypi/gltools
.. _pypi: http://pypi.python.org/pypi/gltools
.. _AUR: https://aur.archlinux.org/packages/?O=0&K=gltools

41
gltools/@docs/index.rst
View file

@ -1,9 +1,7 @@
gltools documentation
=====================
Overview
========
**Overview**
gltools is library for quickly creating OpenGL based
**gltools** is library for quickly creating OpenGL based
application in Python/Cython with support for:
* Access to vertex buffers and GLSL shaders
@ -17,6 +15,29 @@ graphics.
The license is GPL v2.
Building
========
* Python 2.7/3.x and Cython 0.17 or later.
* The geotools_ library.
* GLFW_ v3.0 (not released, must be build from GIT repo)
* OpenGL headers
Prebuild installers are available on the pypi_ site
for the Windows platform.
For Linux build scripts are available for ArchLinux in the AUR_
repository. These could be adapted to other Linux distros.
Note that currently I can not find a way to install the required
Cython 'pxd' files with distutils and this file has to be copied
manually.
History
=======
* v0.1.1 : Added missing files and fix building against GLFW3 trunk.
API Docs
========
@ -30,4 +51,12 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* :ref:`search`
.. _geotools: http://github.com/tenko/geotools
.. _GLFW: http://github.com/elmindreda/glfw
.. _pypi: http://pypi.python.org/pypi/gltools
.. _AUR: https://aur.archlinux.org/packages/?O=0&K=gltools