9fa63137d05a24a1a2af44bc83ad5982130b27c3
[blender-staging.git] / readme.txt
1 Welcome to the fun world of open-source.
2
3 This file is to help you get started using the source and will hopefully
4 answer most questions.
5
6 Here are some links to external packages you may or maynot need:
7
8 openssl:  http://www.openssl.org
9 python:  http://www.python.org
10 mxtexttools:http://www.egenix.com/files/python/mxTextTools.html (python lib)
11 nspr:  ftp://ftp.mozilla.org/pub/nspr/releases
12 libjpeg:  http://www.ijg.org/
13 libpng:  http://www.libpng.org/pub/png/
14 zlib:   http://www.gzip.org/zlib/
15 openal:  http://www.openal.org/home/            (for linux/windows)
16         sdl: http://www.libsdl.org/index.php (for openal)
17         smpeg: http://www.lokigames.com/development/smpeg.php3 (for openal)
18 fmod: http://www.fmod.org/
19
20 If you do not have GL you will also need mesa:
21 http://www.mesa3d.org
22
23 --------------Basic Makefile TIPS---------------------------------------
24 Assuming you are using tcsh/csh do the following before compiling.
25 #Set this to wherever you have extracted the source.
26 setenv NANBLENDERHOME `pwd`
27 setenv MAKEFLAGS "-w -I$NANBLENDERHOME/source"
28
29 Or for bash/sh do this:
30 NANBLENDERHOME=`pwd`
31 export NANBLENDERHOME
32 MAKEFLAGS="-w -I$NANBLENDERHOME/source"
33 export MAKEFLAGS
34
35 Then edit source/nan_definitions.mk to fit you're environment.
36 (You'll want to change things like NAN_OPENSSL,NAN_JPEG, NAN_PNG etc.. 
37 to point to where you have it installed)
38
39 If you tried to just have a go at making stuff you might wind up with
40 an empty file /tmp/.nanguess
41 You need to remove the empty file and it will get created automatically
42 by $NANBLENDERHOME/source/tools/guess/guessconfig after you have 
43 setup the NANBLENDERHOME variable.
44
45 After that cd $NANBLENDERHOME/intern 
46 make
47 make install
48
49 Then cd $NANBLENDERHOME/intern/python/freeze 
50 make
51 cd $NANBLENDERHOME/source/blender/bpython/frozen
52 make -f Makefile.freeze
53
54 Then cd $NANBLENDERHOME/source
55 make
56
57 If you have any problems with the above post a message to the Forums on
58 www.blender.org
59 ----------------------WINDOWS TIPS--------------------------------------
60 If you have any problems with the above post a message to the Forums on
61 www.blender.org
62
63
64 ----------------------Mac OSX TIPS--------------------------------------
65 Now before you go to the source directory, make sure you have installed the
66 external libraries that Blender depends upon. Here is a description of the 
67 things you need.
68
69 FINK:
70 Use fink (http://fink.sourceforge.net/) to install the following libraries that
71 Blender depends on:
72 1. openssl (fink install openssl)
73 2. jpeg    (fink install jpeg)
74 3. png     (fink install png)
75
76 PYTHON:
77 Mac OSX 10.2 (Jaguar) now comes with Python (2.2.1) pre-installed. This is fine
78 for producing the "frozen" Python code found in the intern directory. However,
79 the installation does not contain the python library to link against (at least
80 I could not find it). You could use fink to install Python but that Python 
81 installation depends on X being installed and that is a large installation.
82
83 If you prefer the easy way: download Python 2.2.2 from http://www.python.org.
84 Follow the instructions to in the documentation to install it on your box. If
85 you run OSX 10.2 it should install just fine. Basically a configure and a 
86 "make" will do the job. The result is a Python library that should be copied to
87 the library tree together with the associated header files.
88
89 Create the following  directories:
90 $NANBLENDERHOME/lib/darwin-6.1-powerpc/python/include/python2.2
91 $NANBLENDERHOME/lib/darwin-6.1-powerpc/python/lib/python2.2/config
92 Now copy the include files and the libpython2.2.a library to those locations.
93
94 FMOD:
95 Download FMOD from http://www.fmod.org/ and unpack with StuffIt Expander. The
96 archive contains header files and a library. Copy those to these directories
97 (that you need to create first):
98 $NANBLENDERHOME/lib/darwin-6.1-powerpc/fmod/include
99 $NANBLENDERHOME/lib/darwin-6.1-powerpc/fmod/lib
100
101 RANLIB:
102 Although the make files run ranlib on the libraries built, the gcc linker 
103 complains about ranlib not being run. Until there is a solution, you will need
104 to run ranlib by hand once in a while when the make breaks. Luckily, the error
105 message lists the full path of the file to run ranlib on... Anybody out there 
106 with a real solution? I guess the problem arises from copying the files from 
107 one location to the other...
108
109 Now wait, don't type make yet! You'll have to edit a config file of ODE first.
110 go to $NANBLENDERHOME/source/ode/config and edit the file "user-settings" so 
111 that platform is equal to osx (PLATFORM=osx).
112
113 Success!