Ok I added the following options to configure.ac
[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.  If you want to
30 get a working blender skip down to the next section and use this readme as
31 a guide.
32
33 If you want to play with the new autoconf environment you need to do the 
34 following, inside this dir:
35 ./bootstrap
36 mkdir ../newdir
37 cd ../newdir
38 ../blender/configure
39
40 Take a look at INSTALL for options you can give to configure.
41 About half of the intern directory is done so you won't get very far.
42 If you want to work on fixing it you need to edit Makefile.am's and 
43 configure.ac
44 after editing those files you need to run bootstrap again.
45
46 TODO to finish up the intern dir
47 Square away how ghost works.
48 (i.e. would be nice if under windows you could choose X11 or normal windows
49 libs, same with macos.. right now its a cludge and it doesn't do one explicitly
50 probably involves changing the way configure.ac picks stuff)
51
52 Get intern/python figured out.
53 fix the following in configure.ac
54         --with-mozilla=dir      (get it so nspr is autodetected here)
55         --with-nspr=dir         (incase in different dir)
56
57 *********************************************************************
58 *********************************************************************
59
60 --Notes on compiling mxTextTools----------------------------------------------
61 To get the latest version to compile on my machine I had to
62 edit mxSetup.py and remove /usr/include from INCLPATH for it to build
63 properly.
64 (after doing this you need to edit blender/source/Makefile and
65 fix the pointer to it I'm still working on automating this)
66
67 --------------Basic Makefile TIPS---------------------------------------
68 Assuming you are using tcsh/csh do the following before compiling.
69 #Set this to wherever you have extracted the source.
70 setenv NANBLENDERHOME `pwd`
71 setenv MAKEFLAGS "-w -I$NANBLENDERHOME/source"
72
73 Or for bash/sh do this:
74 NANBLENDERHOME=`pwd`
75 export NANBLENDERHOME
76 MAKEFLAGS="-w -I$NANBLENDERHOME/source"
77 export MAKEFLAGS
78
79 Then edit source/nan_definitions.mk to fit you're environment.
80 (You'll want to change things like NAN_OPENSSL,NAN_JPEG, NAN_PNG etc.. 
81 to point to where you have it installed)
82
83 If you tried to just have a go at making stuff you might wind up with
84 an empty file /tmp/.nanguess
85 You need to remove the empty file and it will get created automatically
86 by $NANBLENDERHOME/source/tools/guess/guessconfig after you have 
87 setup the NANBLENDERHOME variable.
88
89 After that cd $NANBLENDERHOME/intern 
90 make
91 make install
92
93 cd $NANBLENDERHOME/source/ode
94 Look at the README_BLENDER and follow instructions
95
96 Then cd $NANBLENDERHOME/source
97 make
98
99 If you have any problems with the above post a message to the Forums on
100 www.blender.org
101 ----------------------WINDOWS TIPS--------------------------------------
102 If you have any problems with the above post a message to the Forums on
103 www.blender.org
104
105
106 ----------------------Mac OSX TIPS--------------------------------------
107 Now before you go to the source directory, make sure you have installed the
108 external libraries that Blender depends upon. Here is a description of the 
109 things you need.
110
111 FINK:
112 Use fink (http://fink.sourceforge.net/) to install the following libraries that
113 Blender depends on:
114 1. openssl (fink install openssl)
115 2. jpeg    (fink install jpeg)
116 3. png     (fink install png)
117
118 PYTHON:
119 Mac OSX 10.2 (Jaguar) now comes with Python (2.2.1) pre-installed. This is fine
120 for producing the "frozen" Python code found in the intern directory. However,
121 the installation does not contain the python library to link against (at least
122 I could not find it). You could use fink to install Python but that Python 
123 installation depends on X being installed and that is a large installation.
124
125 If you prefer the easy way: download Python 2.2.2 from http://www.python.org.
126 Follow the instructions to in the documentation to install it on your box. If
127 you run OSX 10.2 it should install just fine. Basically a configure and a 
128 "make" will do the job. The result is a Python library that should be copied to
129 the library tree together with the associated header files.
130
131 Create the following  directories:
132 $NANBLENDERHOME/lib/darwin-6.1-powerpc/python/include/python2.2
133 $NANBLENDERHOME/lib/darwin-6.1-powerpc/python/lib/python2.2/config
134 Now copy the include files and the libpython2.2.a library to those locations.
135
136 FMOD:
137 Download FMOD from http://www.fmod.org/ and unpack with StuffIt Expander. The
138 archive contains header files and a library. Copy those to these directories
139 (that you need to create first):
140 $NANBLENDERHOME/lib/darwin-6.1-powerpc/fmod/include
141 $NANBLENDERHOME/lib/darwin-6.1-powerpc/fmod/lib
142
143 RANLIB:
144 Although the make files run ranlib on the libraries built, the gcc linker 
145 complains about ranlib not being run. Until there is a solution, you will need
146 to run ranlib by hand once in a while when the make breaks. Luckily, the error
147 message lists the full path of the file to run ranlib on... Anybody out there 
148 with a real solution? I guess the problem arises from copying the files from 
149 one location to the other...
150
151 Now wait, don't type make yet! You'll have to edit a config file of ODE first.
152 go to $NANBLENDERHOME/source/ode/config and edit the file "user-settings" so 
153 that platform is equal to osx (PLATFORM=osx).
154
155 Success!