Added a function for importers to use, comprehensive image loader takes an imagepath...
[blender.git] / doc / README.windows-gcc
index e20e7ff55856a030435f4496ca29e4418c0ae299..78018eabbc0cc572ba7eb43355ff69c63b69b4cc 100644 (file)
@@ -1,5 +1,12 @@
+An updated version of this guide can be found at:
+
+http://www.blender3d.org/cms/Building_with_Cygwin.524.0.html
+
+Introduction
+------------
+
 Here are some basic instructions for building
-blender blender for windows using gcc under cygwin.
+blender for windows using gcc under cygwin.
 Please note that the resulting executable does not
 depend on cygwin and can be distrubuted to machines
 that don't have cygwin installed.
@@ -7,10 +14,10 @@ that don't have cygwin installed.
 The instructions are:
 
 1. Download cygwin (www.cygwin.com) and use the setup program
-   to install packages for gcc, gcc-mingw, w32api, make, cvs,
-   python, and perl (and maybe others... the dependency list
-   is bound to change over time and hopefully these instructions
-   will keep with the changes). All of the following
+   to install packages for gcc, gcc-mingw, gcc-g++, w32api, make, cvs,
+   python, perl, gettext, and gettext-devel (and maybe others... the 
+   dependency list is bound to change over time and hopefully these 
+   instructions will keep up with the changes). All of the following
    commands will be entered at the cygwin prompt so launch
    cygwin now.
 
@@ -19,20 +26,30 @@ The instructions are:
      mkdir bf-blender
      cd bf-blender
 
-3. checkout the blender module from the bf-blender tree using cvs 
+   *********WARNING: if the directory path you are in contains a space in
+   it you will get errors in trying to compile the code.  Change directorys
+   to a one that does not contain a space in the path before creating the
+   above directory *********
+
+
+Please note that a backslash at the end of a line in the following 
+means that the command spans two lines. If you wish to type the command as 
+one line, exclude the '\'.
+
+3. Checkout the blender module from the bf-blender tree using cvs 
    (use password anonymous):
      cvs -d:pserver:anonymous@cvs.blender.org:/cvsroot/bf-blender login
      cvs -z3 -d:pserver:anonymous@cvs.blender.org:/cvsroot/bf-blender \
           co blender
 
-4. checkout the lib/windows module from bf-blender using cvs:
+4. Checkout the lib/windows module from bf-blender using cvs:
      cvs -z3 -d:pserver:anonymous@cvs.blender.org:/cvsroot/bf-blender \
           co lib/windows
 
 5. Enter the newly created blender directory:
      cd blender
 
-6. to prepare the build system to use only the free tools we must
+6. To prepare the build system to use only the free tools we must
    set some environment variables. This is done by creating a
    file called "user-def.mk" in the blender directory and
    inserting the following line with notepad or your favorite
@@ -50,9 +67,15 @@ The instructions are:
    'outside' that I am told is nice to go to while waiting for a 
    compile to finish).
 
+9. After it finishes compiling, if you would like to run your freshly compiled
+   blender, type make release.  Then change directorys to obj/233.a/ and move
+   the zip file to where you want to use it, unzip the file, enter the directory
+   and run your brand new blender.
+
+
 Getting Help
 ------------
-If you have problems, come by #blendersauce on irc.freenode.net
+If you have problems, come by #blendercompilers on irc.freenode.net
 or post questions to the "Compiling, Libraries, Modules" forum
 at www.blender.org. There is also the very useful bf-committers 
 mailing list, what you can subscribe to here:
@@ -73,6 +96,9 @@ Some final notes
   based laptop).
 - If the build is successful you will find it has created
   the program obj/windows/bin/blender.exe
+- The executable generated by gcc will generally be slower
+  that an msvc++ generated executable at rendering, but the 
+  OpenGL speed should be about the same.
 - Sound is disabled
 - If you want to clean your sources issue a 'make clean'
   in the top blender directory.
@@ -88,4 +114,10 @@ Some final notes
   to your buddies? Try "make release" ... read the output
   to find out where the zip file was placed (note: you will
   probably need the zip/unzip packages from cygwin to do
-  this)
+  this).
+- You can make a debug executable using 'make debug'. The
+  debug executable will be larger and slower that the
+  regular executable, but when used with the gnu debugger
+  (gdb) it can help debug a blender problem (for example,
+  it can locate the line of code that caused blender to
+  crash).