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