Commits

aholkner  committed 508d3e5

Added home page.

  • Participants
  • Parent commits 0be2e49
  • Branches ctypes-soc

Comments (0)

Files changed (2)

File doc/index.txt

+SDL-ctypes
+==========
+
+SDL-ctypes is a Python wrapper around SDL_ using ctypes_.  SDL-ctypes is
+currently maintained by `Alex Holkner`_ and supported by `Google Summer of
+Code 2006`_.
+
+What's it for?
+--------------
+
+In its current state most of the core SDL modules have been wrapped,
+and is completely usable for applications that wish to access the
+SDL library directly.
+
+The eventual aim of this project is to rewrite Pygame_ using this SDL
+wrapper.  This would have several benefits over the current Python
+extension:
+
+* It would allow Python programmers to extend Pygame and use extra
+  features of SDL with far less effort than is currently required.
+* The wrapper can be used on any platform that supports ctypes
+  and SDL, and requires no compilation or native code.
+* Several Python or Python-like implementations such as PyPy and
+  Pyrex are emerging which can make use of this library simply
+  by implementing ctypes.
+
+Download
+--------
+
+The latest source release is:
+
+* `SDL-ctypes-0.3 <SDL-ctypes-0.3.tar.gz>`_
+
+You can also access the SVN repository directly::
+
+    svn co svn://pygame.org/svn/pygame/branches/ctypes-soc
+
+Documentation
+-------------
+
+Documentation included in the source distribution under the ``doc``
+directory.  It is also browseable online:
+
+* `Manual <manual/index.html>`_
+* `API reference <api/index.html>`_
+
+.. _SDL: http://www.libsdl.org
+.. _ctypes: http://starship.python.net/crew/theller/ctypes
+.. _Alex Holkner: mailto:aholkner@cs.rmit.edu.au
+.. _Google Summer of Code 2006: http://code.google.com/soc
+.. _Pygame: http://www.pygame.org
     '/usr/lib/python2.4/site-packages/docutils/tools/python_latex.py'
 mkhowto = \
     '/usr/share/doc/Python-2.5a2/tools/mkhowto'
+rst2html = \
+    'rst2html.py'
 
 class ApiDocCommand(Command):
     description = 'generate HTML API documentation'
         subprocess.call('%s manual.txt > manual.tex' % latex_writer, shell=True)
         subprocess.call('%s --split=4 manual.tex' % mkhowto, shell=True)
         os.chdir(olddir)
+
+class DocCommand(Command):
+    description = 'generate HTML index page'
+    user_options = []
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        olddir = os.getcwd()
+        os.chdir(doc_dir)
+        subprocess.call('%s index.txt > index.html' % rst2html, shell=True)
+        os.chdir(olddir)
+
 setup(
     name='SDL-ctypes',
-    version='0.02',
+    version='0.03',
     description='ctypes wrapper for SDL',
     author='Alex Holkner',
     author_email='aholkner@cs.rmit.edu.au',
     url='http://www.pygame.org/ctypes',
     license='LGPL',
-    cmdclass={'apidoc':ApiDocCommand, 'manual':ManualDocCommand},
+    cmdclass={'apidoc':ApiDocCommand, 
+              'manual':ManualDocCommand,
+              'doc':DocCommand},
     packages=['SDL'],
 )