source: trunk/README @ 1378

Last change on this file since 1378 was 1371, checked in by Peter, 14 years ago

Adding a README.developer and moving developer specific information
into that file. Also adding blurp on how to use gdb on a shared
library. Since developers are supposed to checkout from repository
README.developer is not included in distribution.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
  • Property svn:mime-type set to text/x-trac-wiki
File size: 3.9 KB
RevLine 
[2]1$Id: README 1371 2008-07-15 18:26:58Z peter $
2
[573]3
[1262]4= Compiling =
[573]5
[1262]6 1. If you checked out this project from the subversion repository you
7    must run '`bootstrap`' to initialize the build system.
8 2. Issue '`./configure`' to create the Makefiles. Optionally run
9    configure with '`--enable-debug`', which will turn on debug
10    options.
11 3. Compile with '`make`'.
[1303]12 4. Optionally do '`make check`' to run test programs.
13 5. '`make doc`' will generate documentation.
14 6. Issue '`make install`' to install the package on your system,
15    documentation will not be installed if documentation was not
16    generated above. Default installation location is `/usr/local`,
17    this can be changed with
18    '`./configure --prefix=/dir/to/install/to`'.
[573]19
[953]20If you keep your working copy up to date with the repository you must
21issue 'autoreconf' in the yat root directory when 'configure.ac' is
22updated.
[848]23
[1059]24
25= Requirements =
26
[1262]27Except for the obviously needed C++ compiler there are a few packages
28and programs required for compiling yat and generate supporting
29material. The configure script will look for required programs and
30report failure to meet the requirements. Here we list some of the
31requirements, but omit required standard utilities such as libtool and
32sed since these are normally available.
[1059]33
[1262]34== Required packages ==
[1059]35
[1262]36=== GSL ===
[1059]37
[1262]38GNU Scientific Library, [http://www.gnu.org/software/gsl/ GSL] version
[1287]391.8 or later.
[1059]40
[1262]41=== BLAS ===
[1059]42
[1262]43A C implementation of Basic Linear Algebra Subprograms
44([http://www.netlib.org/blas BLAS]) is required. GSL comes with a
45reference implementation, but you should consider getting a hardware
46optimized implementation. ATLAS provides optimized BLAS (see below).
[1059]47
[1325]48=== Boost ===
49
50[http://www.boost.org Boost] version 1.33 or later.
51
[1262]52=== quiet nan ===
[1059]53
[1262]54Quiet NaN's must be supported.
[1059]55
[1353]56=== infinity ===
57
58infinity for type double must be supported.
59
[1262]60== Optional packages ==
[1059]61
[1262]62=== ATLAS ===
63
[1059]64GSL supplies a reference implementation of BLAS. You may want to
[1262]65consider using hardware optimized BLAS. The
66[http://math-atlas.sourceforge.net/ ATLAS] software provides an
67automatic hardware optimized BLAS library.
[1059]68
69The detection of ATLAS is supported by the yat configuration script
70but in many cases the ATLAS libraries are installed in
[1262]71non-conventional directory locations. As an example, on Fedora 8,
72ATLAS libraries are
[1059]73located in /usr/lib/atlas or /usr/lib64/atlas depending on your
74hardware architecture. If you have ATLAS installed and the configure
75script fails to locate it, try to add the location to the atlas
[1078]76libraries when running configure:
[1059]77
[1180]78  #> LDFLAGS="-L/usr/lib64/atlas" ./configure
[1059]79
[1262]80=== Doxygen ===
[1059]81
[1272]82[http://www.doxygen.org/ Doxygen] is required for generation of the
[1262]83API documentation
84
[1272]85= Documentation =
[1262]86
[1272]87The API documentation for the latest release is availabe in PDF and
88HTML and can be found through http://trac.thep.lu.se/yat. If you wish
89to build a local copy, issue `make doc` and you will find the
90documents in directory `doc/`.
[1262]91
[1368]92= Developers =
93
[1371]94See file README.developer for developer specific information.
[1368]95
[1262]96----------------------------------------------------------------------
97{{{
98Copyright (C) 2003 Jari Häkkinen, Peter Johansson
99Copyright (C) 2004 Jari Häkkinen
[1275]100Copyright (C) 2006, 2007, 2008 Jari Häkkinen, Peter Johansson
[1262]101
102This file is part of yat library, http://trac.thep.lu.se/yat
103
104The yat library is free software; you can redistribute it and/or
105modify it under the terms of the GNU General Public License as
106published by the Free Software Foundation; either version 2 of the
107License, or (at your option) any later version.
108
109The yat library is distributed in the hope that it will be useful, but
110WITHOUT ANY WARRANTY; without even the implied warranty of
111MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
112General Public License for more details.
113
114You should have received a copy of the GNU General Public License
115along with this program; if not, write to the Free Software
116Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
117USA.
118}}}
Note: See TracBrowser for help on using the repository browser.