[Pyxine-checkins] pyxine ChangeLog,1.6,1.7 README,1.3,1.4

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/pyxine/pyxine
In directory sc8-pr-cvs1:/tmp/cvs-serv24415

Modified Files:
	ChangeLog README 
Log Message:
Convert to reStructuredMarkup formatting.  Added some text.
(README is now on the pyxine web site.)


Index: ChangeLog
===================================================================
RCS file: /cvsroot/pyxine/pyxine/ChangeLog,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7

--- ChangeLog	12 Feb 2003 21:03:17 -0000	1.6
+++ ChangeLog	13 Feb 2003 05:53:21 -0000	1.7
@@ -1,5 +1,14 @@
 2003-02-12  Geoffrey T. Dairiki  <da...@da...>
 
+	* README (README): Convert to reStructuredMarkup formatting.
+	Added some text.  (README is now on the pyxine web site.)
+
+2003-02-12  Geoffrey T. Dairiki  <da...@da...>
+
+	=================
+	Release 0.1alpha2
+	=================
+
 	* Makefile: Increment PYXINE_VERSION
 
 	* README: Instructions for playing an audio file were wrong.

Index: README
===================================================================
RCS file: /cvsroot/pyxine/pyxine/README,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- README	12 Feb 2003 19:03:28 -0000	1.3
+++ README	13 Feb 2003 05:53:21 -0000	1.4
@@ -1,66 +1,144 @@
-OVERVIEW
+==============
+README: Pyxine
+==============
 
-    Pyxine is a Python package which provides Python bindings for
-    libxine, the backend of the xine media player (see http://xinehq.de/).
+..
+  :Author:   Geoffrey T. Dairiki
+  :Contact:  da...@us...
+  :Date:     $Date$
+  :Web Site: http://pyxine.sourceforge.net/
 
-    Using Pyxine, it is possible to write simple (or complex)
-    user-interfaces to xine.  This makes it much easier for one to
-    write custom xine UIs.
+.. contents:: Table of Contents
 
-    For the latest news and updates, make sure to check the Pyxine
-    web page: http://pyxine.sourceforge.net/
 
-REQUIREMENTS
+Overview
+========
 
-    To build and install this package, you'll need:
+Pyxine is a `Python`_ package which provides Python bindings for
+`libxine`_, the backend of the `xine media player`_.
+Using Pyxine, it is possible to write simple (or complex)
+user-interfaces to xine.  This makes it much easier for one to
+write custom xine UIs.
 
-        - Python 2.2 or better
-	- Modern GNU gcc/g++
-	- xine-lib-1-beta4 (or better)
+Pyxine is very much a work-in-progress.  It seems to work for me
+(but consider yourself lucky if you can get it to work without a hitch.)
+The API is subject to change without notice.
 
-    If you want to hack the source, you'll also probably need:
+For the latest news and updates, make sure to check the
+`Pyxine web page`_.
 
-	- SWIG (I'm using version 1.1)
-	- GNU make
 
-INSTALLATION
+Requirements
+============
 
-    Installation (hopefully) is as simple as:
+To build and install this package, you'll need:
 
-	python setup.py install
+- Python 2.2 or better.  (2.1 might work?)
+- Modern GNU gcc/g++
+- xine-lib-1-beta4 (or better)
 
-    See http://www.python.org/doc/current/inst/ for more details.
+If you want to hack the source, you'll also probably need:
 
-USAGE
+- SWIG (I'm using version 1.1)
+- GNU make
 
-    Playing an audio file can be as simple as:
+Installation
+============
 
-        >>> import pyxine
-        >>> xine = pyxine.Xine()
-        >>> stream = xine.stream_new()
-        >>> stream.open("music.mp3")
-        >>> stream.play()
+Installation (hopefully) is as simple as::
 
-    To play a movie, it will probably take a little more work in order to
-    properly initialize the video output driver.  For now, have a look at
-    ``tkplayer.py`` and ``player.py`` in the ``examples`` subdirectory.
+  python setup.py install
+
+See also: `Installing Python Modules`_.
+
+
+Usage
+=====
+
+Playing an audio file can be as simple as:
+
+>>> import pyxine
+>>> xine = pyxine.Xine()
+>>> stream = xine.stream_new()
+>>> stream.open("music.mp3")
+>>> stream.play()
+
+To play a movie, it will probably take a little more work in order to
+properly initialize the video output driver.  For now, have a look at
+``tkplayer.py`` and ``player.py`` in the ``examples`` subdirectory.
     
-    E.g., if you have the Tkinter package installed::
+E.g., if you have the `Tkinter` package installed::
 
-        # python tkplayer.py some_movie.avi
+    # python tkplayer.py some_movie.avi
 
-    might actually play a movie for you.  (Hit 'p' to start playback.)
+might actually play a movie for you.  (Hit ``p`` to start playback.)
 
-    FIXME
+**FIXME**: need more here
 
-ROADMAP
+Bugs & Questions
+================
+
+Feel free to ask questions and make bug reports.  You may e-mail `me`_
+directly, or better yet, (especially if your question is one others
+might be interested in)  post it to the `pyxine-devel`_ mailing list,
+<mailto:pyx...@li...>.
+
+Roadmap
+=======
+
+Here's the beginnings of an outline to the internals of Pyxine.
     
-    pyxine.libxine
+pyxine.libxine
+-------------- 
 
-        This module is a raw interface to libxine which is more-or-less automatically
-        generated by SWIG.  (See http://www.swig.org/)
+This module is a raw interface to libxine which is more-or-less
+automatically generated by `SWIG`_.
 
-        You should probably not use this module directly, as the rest of the pyxine
-        package provides a friendlier object-oriented wrapper over the the functions
-        in this module.
+You should probably not use this module directly, as the rest of the
+pyxine package provides a friendlier object-oriented wrapper over
+the the functions in this module.
+
+pyxine.pxlib, pyxine.pxlibc
+---------------------------
+
+This is some support code written in C++, along with its `SWIG`_
+generated wrappers.  It handles some of the dirty details associated
+with running a `xine`_ in an X11 window.
+
+The code in pxlib catches ``ShmCompletion`` and ``Exposure`` events
+and passes them on to `xine`_.   It also provides some glue for the
+callbacks ``frame_output_cb`` and ``dest_size_cb``, as well as providing
+for the caching of return values from those callback.
+
+**FIXME**: need more here
+
+the rest
+--------
+
+The rest of the code in the package is a higher-level, object-oriented
+wrapper over the interface presented by ``libxine``.
+
+**FIXME**: need more here
+
+.. References
+   ==========
+
+.. _xine: http://xinehq.de/
+.. _libxine: xine_
+.. _xine media player: xine_
+.. _Pyxine web page: http://pyxine.sourceforge.net/
+.. _Python: http://www.python.org/
+.. _Installing Python Modules: http://www.python.org/doc/current/inst/
+.. _SWIG: http://www.swig.org/
+.. _me: mailto:da...@us...
+.. _pyxine-devel: http://lists.sourceforge.net/lists/listinfo/pyxine-devel
+
+
 
+..
+   Local Variables:
+   mode: indented-text
+   indent-tabs-mode: nil
+   sentence-end-double-space: t
+   fill-column: 70
+   End:




