Ignore:
Timestamp:
Jul 15, 2008, 8:26:58 PM (12 years ago)
Author:
Peter
Message:

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.

File:
1 copied

Legend:

Unmodified
Added
Removed
  • trunk/README.developer

    r1368 r1371  
    11$Id$
    22
    3 
    4 = Compiling =
    5 
    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`'.
    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`'.
    19 
    20 If you keep your working copy up to date with the repository you must
    21 issue 'autoreconf' in the yat root directory when 'configure.ac' is
    22 updated.
    23 
    24 
    25 = Requirements =
    26 
    27 Except for the obviously needed C++ compiler there are a few packages
    28 and programs required for compiling yat and generate supporting
    29 material. The configure script will look for required programs and
    30 report failure to meet the requirements. Here we list some of the
    31 requirements, but omit required standard utilities such as libtool and
    32 sed since these are normally available.
    33 
    34 == Required packages ==
    35 
    36 === GSL ===
    37 
    38 GNU Scientific Library, [http://www.gnu.org/software/gsl/ GSL] version
    39 1.8 or later.
    40 
    41 === BLAS ===
    42 
    43 A C implementation of Basic Linear Algebra Subprograms
    44 ([http://www.netlib.org/blas BLAS]) is required. GSL comes with a
    45 reference implementation, but you should consider getting a hardware
    46 optimized implementation. ATLAS provides optimized BLAS (see below).
    47 
    48 === Boost ===
    49 
    50 [http://www.boost.org Boost] version 1.33 or later.
    51 
    52 === quiet nan ===
    53 
    54 Quiet NaN's must be supported.
    55 
    56 === infinity ===
    57 
    58 infinity for type double must be supported.
    59 
    60 == Optional packages ==
    61 
    62 === ATLAS ===
    63 
    64 GSL supplies a reference implementation of BLAS. You may want to
    65 consider using hardware optimized BLAS. The
    66 [http://math-atlas.sourceforge.net/ ATLAS] software provides an
    67 automatic hardware optimized BLAS library.
    68 
    69 The detection of ATLAS is supported by the yat configuration script
    70 but in many cases the ATLAS libraries are installed in
    71 non-conventional directory locations. As an example, on Fedora 8,
    72 ATLAS libraries are
    73 located in /usr/lib/atlas or /usr/lib64/atlas depending on your
    74 hardware architecture. If you have ATLAS installed and the configure
    75 script fails to locate it, try to add the location to the atlas
    76 libraries when running configure:
    77 
    78   #> LDFLAGS="-L/usr/lib64/atlas" ./configure
    79 
    80 === Doxygen ===
    81 
    82 [http://www.doxygen.org/ Doxygen] is required for generation of the
    83 API documentation
    84 
    85 = Documentation =
    86 
    87 The API documentation for the latest release is availabe in PDF and
    88 HTML and can be found through http://trac.thep.lu.se/yat. If you wish
    89 to build a local copy, issue `make doc` and you will find the
    90 documents in directory `doc/`.
    91 
    92 = Developers =
    933
    944yat uses gnu Libtool in order to build shared libraries on a variety
     
    10010----------------------------------------------------------------------
    10111{{{
    102 Copyright (C) 2003 Jari Häkkinen, Peter Johansson
    103 Copyright (C) 2004 Jari Häkkinen
    104 Copyright (C) 2006, 2007, 2008 Jari Häkkinen, Peter Johansson
     12Copyright (C) 2008 Peter Johansson
    10513
    10614This file is part of yat library, http://trac.thep.lu.se/yat
Note: See TracChangeset for help on using the changeset viewer.