| 1 | PySoy Installation Guide |
|---|
| 2 | ======================== |
|---|
| 3 | While many PySoy users will grab the latest pre-packaged release with |
|---|
| 4 | everything taken care of for them, users and developers compiling from |
|---|
| 5 | Mercurial or building a package for distribution may need this guide. |
|---|
| 6 | (See the windows_building.txt for instructions to compile/build/install |
|---|
| 7 | on Windows) |
|---|
| 8 | |
|---|
| 9 | |
|---|
| 10 | Dependencies |
|---|
| 11 | ------------ |
|---|
| 12 | You'll want to make sure these are installed before proceeding: |
|---|
| 13 | Python >=2.3 |
|---|
| 14 | OpenAL >=1.1 |
|---|
| 15 | OpenDE >=0.8 |
|---|
| 16 | OpenGL >=1.2 |
|---|
| 17 | GLEW >=1.4 |
|---|
| 18 | GLib >=2.0 |
|---|
| 19 | Cairo >=1.4 |
|---|
| 20 | liboil >=0.3.10 |
|---|
| 21 | libogg >=1.1.2 |
|---|
| 22 | libvorbis >=1.1.2 |
|---|
| 23 | libtheora >=1.0 |
|---|
| 24 | |
|---|
| 25 | |
|---|
| 26 | If you're using a binary-based distribution (such as Ubuntu, Fedora, etc) make |
|---|
| 27 | sure you install the -dev versions of these dependencies. |
|---|
| 28 | |
|---|
| 29 | On Ubuntu 9.04 (Jaunty Jackalope) : |
|---|
| 30 | sudo apt-get install python3.0-dev valac libgtk2.0-dev liboil0.3-dev \ |
|---|
| 31 | libglew1.5-dev libopenal-dev libode-dev \ |
|---|
| 32 | libtheora-dev libvorbis-dev |
|---|
| 33 | |
|---|
| 34 | Note that these package names may vary as new versions are released. |
|---|
| 35 | |
|---|
| 36 | You will also need a working C compiler environment for building Python |
|---|
| 37 | modules (same as your Python version was built with). |
|---|
| 38 | |
|---|
| 39 | |
|---|
| 40 | Compiling |
|---|
| 41 | --------- |
|---|
| 42 | If you're reading this you've already downloaded PySoy. If you have all |
|---|
| 43 | the dependencies installed you should, now, be able to type: |
|---|
| 44 | python setup.py build |
|---|
| 45 | |
|---|
| 46 | and watch it compile. Any compile errors not linked to a missing |
|---|
| 47 | dependency should be reported to our bug tracker (below). |
|---|
| 48 | |
|---|
| 49 | If everything has gone well you can now install the PySoy module with: |
|---|
| 50 | python setup.py install |
|---|
| 51 | |
|---|
| 52 | |
|---|
| 53 | Updating |
|---|
| 54 | -------- |
|---|
| 55 | If you've installed from Mercurial you should be able to update your version |
|---|
| 56 | by changing to this directory and running: |
|---|
| 57 | hg pull -u |
|---|
| 58 | |
|---|
| 59 | Then repeat the compile steps (above). |
|---|
| 60 | |
|---|
| 61 | |
|---|
| 62 | Bug Reporting |
|---|
| 63 | ------------- |
|---|
| 64 | There's a "New Ticket" link at the top of http://pysoy.org/ for reporting |
|---|
| 65 | bugs. You'll need to login to access it, registration should be quick |
|---|
| 66 | and painless while helping us cut down on ticket spam and making it |
|---|
| 67 | easier for us to contact you for more information. |
|---|
| 68 | |
|---|
| 69 | Please select the correct version when filing bug reports and, if |
|---|
| 70 | building from Mercurial, mention the revision number and/or date of last |
|---|
| 71 | update when writing your report. This is very useful to us. |
|---|