Subversion Repositories gelsvn

Rev

Rev 178 | Rev 210 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 178 Rev 209
Line -... Line 1...
-
 
1
GEL README, Andreas Bærentzen, February 2006.
-
 
2
==========
1
 
3
 
2
 GEL README, Andreas Bærentzen, March 05
4
This README describes the GEL project. GEL stands for Geometry and Linear 
-
 
5
Algebra which are the constituents we will mostly put into this library.
3
 
6
 
4
 This README describes the GEL project. GEL stands for Geometry and Linear 
7
There are a good many tools for computational geometry processing: A
-
 
8
voxel grid and a simple triangle mesh data structure. There is also a
-
 
9
more advanced triangle mesh data structure called IMesh and a halfedge
-
 
10
based polygonal mesh data structure called HMesh. There is a very
-
 
11
useful data structure known as a k-D tree and many other things. 
-
 
12
 
5
 Algebra which are the constituents we will mostly put into this library.
13
Also found are two packages for linear algebra: CGLA is strictly for
-
 
14
small vectors and matrices. LinAlg is a Lapack wrapper for slightly
-
 
15
larger problems. At this point, it is fairly simple. 
6
 
16
 
7
 This is a complex source tree which is intended for use both under a 
17
Finally there are some utilities in Util: Getting command line
-
 
18
arguments, hash table classes, a 2D grid class, a resource manager and
-
 
19
other miscellany. 
-
 
20
 
-
 
21
GEL is intended for use both under a  variety of unix platforms (Linux
8
 variety of unix platforms and under windows. This README is mostly for
22
and OSX in particular) and  under windows. This README is mostly for
9
 unix users. Windows users should also consult README_MSVC
23
unix users. Windows users should also consult README_MSVC
-
 
24
 
-
 
25
Dependencies: GEL depends on the Developers Image Library DevIL,
-
 
26
Lapack, and OpenGL and GLUT. However, most of GEL does not require
-
 
27
these dependencies. In particular, you do not need DevIL except if you
-
 
28
want the OBJ viewer example program.
-
 
29
 
-
 
30
Who made GEL
-
 
31
==========
-
 
32
 
-
 
33
GEL is mostly the work of Andreas Bærentzen, but other people
-
 
34
contribute. In particular, Jeppe Frisvad, Bjarke Jakobsen, Henrik
-
 
35
Aanæs, and Bent D. Larsen. We are all from Informatics and
-
 
36
Mathematical Modelling, a department of the Technical University of
-
 
37
Denmark. 
-
 
38
 
-
 
39
Regarding LICENSE.
-
 
40
==========
-
 
41
 
-
 
42
I was considering putting GEL under the LGPL. But it is a long complex
-
 
43
text. The longer any kind of document, the more chances for loopholes
-
 
44
in my opinion. Instead, I list a few simple rules below. The most
-
 
45
important one is that if you want to use GEL for some purpose, and it
-
 
46
is not crystal clear whether it is against the rules, contact me. As
-
 
47
for the rules:
-
 
48
 
-
 
49
You are allowed to use GEL for academic or commercial purposes. In
-
 
50
particular, you are welcome to give GEL to students as a basis for 
-
 
51
academic work or to use it for your own applications.
-
 
52
 
-
 
53
The biggest limitation that I want to impose is that you cannot repackage
-
 
54
GEL in any way. You are not allowed to distribute another library which
-
 
55
contains GEL or parts of GEL unless you make it clear that this other
-
 
56
library contains GEL. You are also not allowed to redistribute GEL in a
-
 
57
changed form. If you want changes to be made, contact me.
-
 
58
 
-
 
59
Of course, neither I nor my employer will give you any money or be
-
 
60
held responsible in any way, under any circumstances what so ever - no
-
 
61
matter what sort of damage GEL might inflict upon you. Not that I can
-
 
62
foresee GEL causing you any damage :-) 
-
 
63
 
-
 
64
If anything is unclear, please contact me. In fact, if you want to use
-
 
65
GEL for a bigger project, I'd appreciate an email to jab@imm.dtu.dk
10
 
66
 
11
======================================================================
67
In a project such as this, it is almost impossible to completely avoid
-
 
68
building upon fragments of other peoples source code. GEL includes an
-
 
69
obj loader based on work by Nate Robins. Some pieces of source code
-
 
70
from Graphics Gems have also been used. All of this amounts to only a
-
 
71
small fraction of the GEL source code and it should not be in
-
 
72
violation of any license. Should you disagree, contact me, and I will
-
 
73
rectify the situation.
12
 
74
 
13
----------------------------------------------------------------------
75
----------------------------------------------------------------------
14
1. INTRODUCTION
76
1. INTRODUCTION
15
----------------------------------------------------------------------
77
----------------------------------------------------------------------
16
 
78