~ubuntu-branches/ubuntu/maverick/glbsp/maverick

« back to all changes in this revision

Viewing changes to INSTALL.txt

  • Committer: Bazaar Package Importer
  • Author(s): Darren Salt
  • Date: 2008-01-30 13:33:49 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080130133349-kgojg33vyiu8xbvp
Tags: 2.24-1
* New upstream release.
* Bumped the lib soname and the library package name due to one silly
  little binary incompatibility caused by changes in an exported struct.
  (Safe; nothing else currently in the archive has ever used libglbsp2.)
* Removed my patches since they're all applied upstream.
* Updated the list of documentation files.
* Build-time changes:
  - Switched from dh_movefiles to dh_install.
  - Updated my makefile to cope with upstream changes.
  - Corrected for debian-rules-ignores-make-clean-error.
  - Corrected for substvar-source-version-is-deprecated.
  - Link libglbsp, rather than glbsp, with libm and libz.
* Fixed shlibdeps. (Closes: #460387)
* Bumped standards version to 3.7.3 (no other changes).

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
Compiling glBSP
3
3
===============
4
4
 
5
 
by Andrew Apted.  13th September 2005.
6
 
 
7
 
 
8
 
glBSP comes in three flavours: a text/command-line utility "glbsp",
9
 
a graphical/GUI version "glBSPX", and it can be compiled as a
10
 
library for other programs to use: "libglbsp".
11
 
 
12
 
Currently the following operating systems are supported: Unix (Linux),
13
 
Windows (95/98/etc), MacOS X, and DOS.  All flavours are supported in
14
 
all systems except for glBSPX and the plugin under DOS.
15
 
 
16
 
There are two compiling methods: using a makefile, and using an IDE.
17
 
Currently the Unix, MacOS X and DOS versions all use makefiles, and
18
 
under Windows there are project files for Dev-C++ (see the "Links"
19
 
below) and for Microsoft MSVC.NET 2002, as well as makefiles for
20
 
MinGW + MingwSYS.
21
 
 
22
 
The GUI version (glBSPX) requires a graphical toolkit called FLTK
23
 
(Fast Light Tool Kit) version 1.1.6.  Other versions may work, but
 
5
by Andrew Apted.  JULY 2007
 
6
 
 
7
 
 
8
glBSP comes in three flavors: a command-line utility "glbsp", a
 
9
graphical/GUI version "glBSPX", and a library for programs to use
 
10
called: "libglbsp".  The source code is structured so that both
 
11
programs link against the library, hence libglbsp is always built.
 
12
 
 
13
The GUI version, glBSPX, requires a graphical toolkit called FLTK
 
14
(Fast Light Tool Kit) version 1.1.7.  Other versions may work, but
24
15
you're on your own there.  See the "Links" section below if you
25
16
need to download it.  
26
17
 
27
 
The Unix makefiles support a "make install", which has to be done
28
 
as root.  None of the other methods have an automatic installation:
29
 
just copy the glbsp (or glBSPX) executable where you want it.
30
 
 
31
 
 
32
 
Command-line glBSP
33
 
------------------
34
 
 
35
 
Unix/Linux: make
36
 
MacOS X:    make -f Makefile.osx
37
 
 
38
 
MSDOS with DJGPP: make -f Makefile.dj
39
 
 
40
 
Windows with MinGW: mingw32-make -f Makefile.w32
41
 
 
42
 
Windows with Dev-C++:  open the Cmdline.dev project file.
43
 
Windows with MSVC.NET: open the Cmdline.vcproj project file.
44
 
 
45
 
 
46
 
Plugin Library
 
18
Sorry to say, but there is no support for compiling with an IDE
 
19
(like Dev-C++ or Visual Studio) in this release.  The directory
 
20
layout was improved when the code moved to the SVN repository,
 
21
but unfortunately this broke all the existing project files.
 
22
 
 
23
 
 
24
NOTE WELL: glBSP is under the GNU General Public License (GPL),
 
25
           hence you cannot use the library (libglbsp) in your
 
26
           own program unless it is also under the GPL.
 
27
 
 
28
           The file COPYING.txt contains a copy of the GPL
 
29
           license, and there is a lot of useful information
 
30
           at this web page: http://www.gnu.org/licenses/
 
31
 
 
32
 
 
33
Linux / Unix Builds
 
34
-------------------
 
35
 
 
36
The makefile is called "Makefile.unx".  You may need to open it
 
37
in an editor and edit some stuff near the top, especially if you
 
38
want to use another compiler (only GNU GCC has been well tested)
 
39
or to change the directory where FLTK can be found.
 
40
 
 
41
To build the library and command-line program:
 
42
 
 
43
   > make -f Makefile.unx
 
44
 
 
45
To build the GUI version:
 
46
 
 
47
   > make -f Makefile.unx glBSPX
 
48
 
 
49
To install the command-line program and manual page:
 
50
 
 
51
   > sudo make -f Makefile.unx install
 
52
 
 
53
 
 
54
Windows Builds
47
55
--------------
48
56
 
49
 
The plugin version of glBSP is a special version that can be used
50
 
within other programs, e.g. a DOOM engine.  The result of the build 
51
 
is a library file: libglbsp.a (libglbsp.lib for VC++ under Win32).
52
 
 
53
 
Unix/Linux: make -f Plugin_unx.mak
54
 
MacOS X:    make -f Plugin_osx.mak
55
 
 
56
 
Windows with MinGW: mingw32-make -f Plugin_w32.mak
57
 
 
58
 
Windows with Dev-C++:  open the Plugin.dev project file.
59
 
Windows with MSVC.NET: open the Plugin.vcproj project file.
60
 
 
61
 
NOTE WELL:
62
 
    Since glBSP is under the GNU General Public License (GPL), it
63
 
    can only be incorporated into other programs that are also
64
 
    under the GPL.  See the file COPYING.txt for all the details.
65
 
 
66
 
 
67
 
Graphical version: glBSPX
68
 
-------------------------
69
 
 
70
 
glBSPX is the GUI version of glBSP, written in C++ and requires the
71
 
FLTK toolkit, version 1.1.6.  FLTK needs to be built before trying
72
 
to build glBSPX: see the next section for some guidelines.
73
 
 
74
 
Unix/Linux: make -f GUI_unx.mak
75
 
MacOS X:    make -f GUI_osx.mak
76
 
 
77
 
Windows with MinGW: mingw32-make -f GUI_w32.mak
78
 
 
79
 
Windows with Dev-C++: open the GUI.dev project file.
80
 
 
81
 
 
82
 
Building FLTK 1.1.6
83
 
-------------------
84
 
 
85
 
Unix / Linux:
86
 
 
87
 
    Use the normal method (configure, make, make install).  Make sure the
88
 
    static library is built (although dynamic should work).  Since OpenGL
89
 
    isn't needed, I usually configure with "--disable-gl".
90
 
 
91
 
MacOS X:
92
 
 
93
 
    Similar, but should use "./configure --prefix=$HOME" (that's where the
94
 
    glBSPX makefile expects to find it).  Edit fltk/makefile.osx if it has
95
 
    been installed somewhere else.  Also I've only tested the static
96
 
    library.
97
 
    
98
 
Windows:
99
 
 
100
 
    Using MinGW: copy the makefiles/makeinclude.mingw31 file to be
101
 
    ./makeinclude, and copy makefiles/config.h to top level.  I then
102
 
    edit config.h to remove OpenGL, PNG and JPEG support.  You may
103
 
    need to changes some / characters to \ in makeinclude and in
104
 
    src/Makefile.  Ignore the top level Makefile, cd into src and
105
 
    invoke mingw32-make.
106
 
 
107
 
    Note that the glBSPX project/make files assume that fltk-1.1.6
108
 
    and glbsp-2.20 are in the same directory.
109
 
 
110
 
 
111
 
Success Stories
112
 
---------------
113
 
 
114
 
The command line version has run successfully on these platforms:
115
 
 
116
 
   +  Linux 2.1.126, libc5, GCC 2.7.2.1.
117
 
   +  Linux 2.2.18, glibc 2.2, GCC 2.95.2.
118
 
   +  Linux 2.4.22-PPC, glibc 2.3.1, GCC 3.2.2.
119
 
 
120
 
   +  MacOS X (10.2.4) with GCC 3.1.
121
 
 
122
 
   +  Win32, with Dev-C++ and MinGW.
123
 
   +  Win32, with MSVC.NET 2002.
124
 
 
125
 
   +  MSDOS 6.22, with DJGPP 2.02.
126
 
 
127
 
   +  IRIX 6.5.
128
 
   +  Digital Unix 4.0.
 
57
The makefile is called "Makefile.w32" and uses the MinGW tools
 
58
(see the link below) for compiling, and you may need MSYS too.
 
59
You will also need the ZLIB library (version 1.2.3) and should
 
60
compile it first.
 
61
 
 
62
To build the library and command-line program:
 
63
 
 
64
   > mingw32-make -f Makefile.w32
 
65
 
 
66
There is no support yet for building the GUI binary natively
 
67
under Windows (sorry).
 
68
 
 
69
 
 
70
Cross-Compiling Win32 Binaries
 
71
------------------------------
 
72
 
 
73
The "Makefile.xming" makefile lets you compile Win32 binaries
 
74
without leaving the comfort of Linux.  You will need to compile
 
75
FLTK and ZLIB libraries first (maybe edit the makefile to set
 
76
their location).
 
77
 
 
78
To build the library and command-line program:
 
79
 
 
80
   > make -f Makefile.xming
 
81
 
 
82
To build the GUI version:
 
83
 
 
84
   > make -f Makefile.xming glBSPX.exe
129
85
 
130
86
 
131
87
Links
132
88
-----
133
89
 
134
 
Dev-C++ (an open source IDE for Windows) home page:
135
 
    http://dev-cpp.sourceforge.net
136
 
 
137
90
Minimum GNU Windows compiler:
138
91
    http://www.mingw.org
139
92
 
140
93
Fast Light Toolkit home page:
141
94
    http://www.fltk.org
142
95
 
 
96
ZLib Compression library:
 
97
    http://www.zlib.net
 
98