Tizen 2.1 base
[platform/upstream/libbullet.git] / Extras / vectormathlibrary / README
1                          Vector math library
2
3
4 * Overview
5
6   The Vector math library provides 3-D/4-D vector operations including
7   addition, outer product, multiply by a matrix, etc.
8
9
10 * License
11
12   This library is licensed under the terms in the file 'LICENSE' in
13   this directory.
14
15
16 * Installing
17
18   To install this library, run following commands:
19
20   - PowerPC with VMX (fully supported)
21
22     $ make ARCH=ppu install
23
24   - SPU (Cell Broadband Engine Synergistic Processor Unit)
25
26     $ make ARCH=spu install
27
28   - x86 with SSE (partially supported)
29
30     $ make ARCH=SSE install
31
32   - Other architectures (partially supported)
33
34     $ make install
35
36
37   By default, files in the library will be placed as below:
38
39   - headers
40   
41     /usr/include/vectormath/c/       (C headers)
42     /usr/include/vectormath/cpp/     (C++ headers)
43
44   - SPU headers
45   
46     /usr/spu/include/vectormath/c/   (C headers)
47     /usr/spu/include/vectormath/cpp/ (C++ headers)
48
49   No shared library, static library nor executable is installed,
50   because all functions in this library are provided as inline
51   functions.
52
53
54 * Packaging
55
56   By running following command in this directory, a source tarball
57   'vectormath-<VERSION>.tar.gz' can be created:
58
59     $ make dist
60   
61   You can also create RPM packages by executing the command below with
62   the tarball:
63
64     $ rpmbuild -tb vectormath-1.0.1.tar.gz --target=ppc
65
66   One or two packages, vectormath-devel (and, in addition,
67   spu-vectormath-devel for PowerPC target), will be created.
68
69
70 * Usage
71
72   See the documents `doc/*.pdf'.
73
74
75 * Contacting the project
76
77   Module maintainer: Erwin Coumans
78
79   Feedback and patches:
80     http://www.bulletphysics.com/Bullet/phpBB2/viewforum.php?f=18
81
82   Main repository URL:
83     http://bullet.svn.sourceforge.net/viewvc/bullet/trunk/Extras/vectormathlibrary
84
85 ---
86 EOF