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