Fixed some stuipid bugs in the Makefile.am's and
[blender.git] / README
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 libjpeg:  http://www.ijg.org/
12 libpng:  http://www.libpng.org/pub/png/
13 zlib:   http://www.gzip.org/zlib/
14 ode:    http://q12.org/ode/ode.html
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 mozilla: http://www.mozilla.org/
21 nspr:  ftp://ftp.mozilla.org/pub/nspr/releases
22         (side note: on debian linux you will need mozilla-dev and libnspr-dev)
23
24 If you do not have GL you will also need mesa:
25 http://www.mesa3d.org
26
27 *********************************************************************
28 *********************************************************************
29 We are in the process of moving things over to automake/autoconf
30 The old makefiles are still in place and will work.  
31 If you want to get a working blender skip down to the next section 
32 and use this readme as a guide.
33
34 If you want to play with the new autoconf environment take a look at 
35 doc/autoconfig.txt
36
37 *********************************************************************
38 *********************************************************************
39
40 --Notes on compiling mxTextTools----------------------------------------------
41 To get the latest version to compile on my machine I had to
42 edit mxSetup.py and remove /usr/include from INCLPATH for it to build
43 properly.
44 (after doing this you need to edit blender/source/Makefile and
45 fix the pointer to it I'm still working on automating this)
46
47 --------------Basic Makefile TIPS---------------------------------------
48 Assuming you are using tcsh/csh do the following before compiling.
49 #Set this to wherever you have extracted the source.
50 setenv NANBLENDERHOME `pwd`
51 setenv MAKEFLAGS "-w -I$NANBLENDERHOME/source"
52
53 Or for bash/sh do this:
54 NANBLENDERHOME=`pwd`
55 export NANBLENDERHOME
56 MAKEFLAGS="-w -I$NANBLENDERHOME/source"
57 export MAKEFLAGS
58
59 Then edit source/nan_definitions.mk to fit you're environment.
60 (You'll want to change things like NAN_OPENSSL,NAN_JPEG, NAN_PNG etc.. 
61 to point to where you have it installed)
62
63 If you tried to just have a go at making stuff you might wind up with
64 an empty file /tmp/.nanguess
65 You need to remove the empty file and it will get created automatically
66 by $NANBLENDERHOME/source/tools/guess/guessconfig after you have 
67 setup the NANBLENDERHOME variable.
68
69 After that cd $NANBLENDERHOME/intern 
70 make
71 make install
72
73 cd $NANBLENDERHOME/source/ode
74 Look at the README_BLENDER and follow instructions
75
76 Then cd $NANBLENDERHOME/source
77 make
78
79 If you have any problems with the above post a message to the Forums on
80 www.blender.org
81 ----------------------WINDOWS TIPS--------------------------------------
82 If you have any problems with the above post a message to the Forums on
83 www.blender.org
84
85
86 ----------------------Mac OSX TIPS--------------------------------------
87 Now before you go to the source directory, make sure you have installed the
88 external libraries that Blender depends upon. Here is a description of the 
89 things you need.
90
91 FINK:
92 Use fink (http://fink.sourceforge.net/) to install the following libraries that
93 Blender depends on:
94 1. openssl (fink install openssl)
95 2. jpeg    (fink install jpeg)
96 3. png     (fink install png)
97
98 PYTHON:
99 Mac OSX 10.2 (Jaguar) now comes with Python (2.2.1) pre-installed. This is fine
100 for producing the "frozen" Python code found in the intern directory. However,
101 the installation does not contain the python library to link against (at least
102 I could not find it). You could use fink to install Python but that Python 
103 installation depends on X being installed and that is a large installation.
104
105 If you prefer the easy way: download Python 2.2.2 from http://www.python.org.
106 Follow the instructions to in the documentation to install it on your box. If
107 you run OSX 10.2 it should install just fine. Basically a configure and a 
108 "make" will do the job. The result is a Python library that should be copied to
109 the library tree together with the associated header files.
110
111 Create the following  directories:
112 $NANBLENDERHOME/lib/darwin-6.1-powerpc/python/include/python2.2
113 $NANBLENDERHOME/lib/darwin-6.1-powerpc/python/lib/python2.2/config
114 Now copy the include files and the libpython2.2.a library to those locations.
115
116 FMOD:
117 Download FMOD from http://www.fmod.org/ and unpack with StuffIt Expander. The
118 archive contains header files and a library. Copy those to these directories
119 (that you need to create first):
120 $NANBLENDERHOME/lib/darwin-6.1-powerpc/fmod/include
121 $NANBLENDERHOME/lib/darwin-6.1-powerpc/fmod/lib
122
123 RANLIB:
124 Although the make files run ranlib on the libraries built, the gcc linker 
125 complains about ranlib not being run. Until there is a solution, you will need
126 to run ranlib by hand once in a while when the make breaks. Luckily, the error
127 message lists the full path of the file to run ranlib on... Anybody out there 
128 with a real solution? I guess the problem arises from copying the files from 
129 one location to the other...
130
131 Now wait, don't type make yet! You'll have to edit a config file of ODE first.
132 go to $NANBLENDERHOME/source/ode/config and edit the file "user-settings" so 
133 that platform is equal to osx (PLATFORM=osx).
134
135 Success!