General formatting clean-up.
[xiph/unicode.git] / ogg-python / README
blob226fbcfba197aa95e31a907c30113220a1d01422
1 pyogg - a Python wrapper for the Ogg libraries
3 Ogg/Vorbis is available at http://www.xiph.org
5 There's not a whole lot you can do with this module by itself. You'll
6 probably also want the ogg.vorbis module, which can be found wherever
7 you got this.
9 You can now write Python programs to encode and decode Ogg Vorbis
10 files (encoding is quite a bit more involved). The module is
11 self-documenting, though I need to update quite a bit of it.
13 And if anyone is wondering why I have things separated into a main
14 module "ogg" and a submodule "ogg.vorbis", vorbis is the audio subset
15 of the ogg bitstream. In the future there will likely be a video part
16 of the ogg bistream, and nothing in the ogg modulue really has to know
17 about anything specific in the vorbis module.
19 To build, you need the distutils package, availible from
20 http://www.python.org/sigs/distutils-sig/download.html (it comes with
21 Python 2.0). Run "python setup.py build" to build and then as root run
22 "python setup.py install". You may need to run the config_unix.py
23 script, passing it a --prefix value if you've installed your ogg stuff
24 someplace weird. Alternately, you can just create a file called
25 "Setup" and put in values for ogg_include_dir, ogg_lib_dir, and
26 ogg_libs. The file format for Setup is:
28 key = value
30 with one pair per line.