GCC 3.4 compile fixes from bug #1277
[blender.git] / doc / README.windows-gcc
1 Here are some basic instructions for building
2 blender for windows using gcc under cygwin.
3 Please note that the resulting executable does not
4 depend on cygwin and can be distrubuted to machines
5 that don't have cygwin installed.
6
7 The instructions are:
8
9 1. Download cygwin (www.cygwin.com) and use the setup program
10    to install packages for gcc, gcc-mingw, gcc-g++, w32api, make, cvs,
11    python, perl, gettext, and gettext-devel (and maybe others... the 
12    dependency list is bound to change over time and hopefully these 
13    instructions will keep up with the changes). All of the following
14    commands will be entered at the cygwin prompt so launch
15    cygwin now.
16
17 2. Create a directory to put your sources and then enter that
18    directory, e.g.:
19      mkdir bf-blender
20      cd bf-blender
21
22    *********WARNING: if the directory path you are in contains a space in
23    it you will get errors in trying to compile the code.  Change directorys
24    to a one that does not contain a space in the path before creating the
25    above directory *********
26
27
28 Please note that a backslash at the end of a line in the following 
29 means that the command spans two lines. If you wish to type the command as 
30 one line, exclude the '\'.
31
32 3. Checkout the blender module from the bf-blender tree using cvs 
33    (use password anonymous):
34      cvs -d:pserver:anonymous@cvs.blender.org:/cvsroot/bf-blender login
35      cvs -z3 -d:pserver:anonymous@cvs.blender.org:/cvsroot/bf-blender \
36           co blender
37
38 4. Checkout the lib/windows module from bf-blender using cvs:
39      cvs -z3 -d:pserver:anonymous@cvs.blender.org:/cvsroot/bf-blender \
40           co lib/windows
41
42 5. Enter the newly created blender directory:
43      cd blender
44
45 6. To prepare the build system to use only the free tools we must
46    set some environment variables. This is done by creating a
47    file called "user-def.mk" in the blender directory and
48    inserting the following line with notepad or your favorite
49    text editor:
50        export FREE_WINDOWS=true
51
52    The quickest way to do this though is to issue the following
53    command:
54       echo 'export FREE_WINDOWS=true' > user-def.mk
55
56 7. Time to build... issue the command:
57      make
58
59 8. Wait for it to finish (there is this mysterious place called 
60    'outside' that I am told is nice to go to while waiting for a 
61    compile to finish).
62
63 9. After it finishes compiling, if you would like to run your freshly compiled
64    blender, type make release.  Then change directorys to obj/233.a/ and move
65    the zip file to where you want to use it, unzip the file, enter the directory
66    and run your brand new blender.
67
68
69 Getting Help
70 ------------
71 If you have problems, come by #blendercoders on irc.freenode.net
72 or post questions to the "Compiling, Libraries, Modules" forum
73 at www.blender.org. There is also the very useful bf-committers 
74 mailing list, what you can subscribe to here:
75
76 http://www.blender.org/mailman/listinfo/bf-committers
77 (as a bonus you can get info about the most recent features that
78 are coming down the pipe ...)
79
80 This said, the most common fix to a problem will
81 probably involve installing an additional cygwin package,
82 so keep that cygwin setup program close by ...
83
84 Some final notes
85 ----------------
86
87 - The build will take a long time, even on a fast machine
88   (a clean build takes almost an hour on my Athlon 1800+
89   based laptop).
90 - If the build is successful you will find it has created
91   the program obj/windows/bin/blender.exe
92 - The executable generated by gcc will generally be slower
93   that an msvc++ generated executable at rendering, but the 
94   OpenGL speed should be about the same.
95 - Sound is disabled
96 - If you want to clean your sources issue a 'make clean'
97   in the top blender directory.
98 - If you want to update your sources when somebody has
99   added a new awesome feature, you will want to go to the
100   topmost blender directory and issue the following command:
101       cvs -z3 update -P -d
102   It would probably be best to clean your sources before
103   re-building (see previous note).
104 - This is a work in progress, so some things may not be working
105   right or it may not support all of the cutting edge features.
106 - Want to make a fancy zipped up blender package to give
107   to your buddies? Try "make release" ... read the output
108   to find out where the zip file was placed (note: you will
109   probably need the zip/unzip packages from cygwin to do
110   this).
111 - You can make a debug executable using 'make debug'. The
112   debug executable will be larger and slower that the
113   regular executable, but when used with the gnu debugger
114   (gdb) it can help debug a blender problem (for example,
115   it can locate the line of code that caused blender to
116   crash).