Ignore:
Timestamp:
Jan 12, 2011, 3:37:21 AM (10 years ago)
Author:
Peter
Message:

improve readability and some minor changes of the text

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/README.developer

    r2384 r2404  
    1414(`make` and `make check`) when someone makes a clean checkout. There
    1515is a short introduction to subversion and its usage available as
    16 [http://cbbp.thep.lu.se/~jari/documents/subversion_guidelines/index.html
    17 Subversion guidelines]. We follow these guidelines.
     16[http://cbbp.thep.lu.se/~jari/documents/subversion_guidelines/index.html Subversion guidelines].
     17We follow these guidelines.
    1818
    1919=== Testing ===
     
    3333
    3434The GSL documentation describes how
    35 [http://www.gnu.org/software/gsl/manual/html_node/Error-Handling.html#Error-Handling GSL error handling]
     35[http://www.gnu.org/software/gsl/manual/html_node/Error-Handling.html GSL error handling]
    3636works. The GSL library follows the thread-safe
    3737error reporting conventions of the posix Threads library. That is,
     
    100100== Requirements ==
    101101
    102 To build from a subversion checkout, you will need Autotools. More
     102To build from a subversion checkout, you will need GNU Autotools. More
    103103specifically
    104  * Automake 1.11 (or later)
    105  * Autoconf 2.63 (or later)
    106  * Libtool.
     104 * Automake 1.11 (or later), http://www.gnu.org/software/automake/
     105 * Autoconf 2.63 (or later), http://www.gnu.org/software/automake/
     106 * Libtool 1.5 (or later), http://www.gnu.org/software/libtool/
    107107
    108108== Disable shared library ==
    109109
    110 yat uses gnu Libtool in order to build shared libraries on a variety
     110yat uses GNU Libtool in order to build shared libraries on a variety
    111111of systems.  While this is very nice for making usable binaries, it
    112112can be a pain when trying to debug a program. For that reason,
     
    116116== Debugging using GDB ==
    117117
    118 If shared library is enabled (default), libtool creates wrapper
    119 scripts in directory test/ that call the test programs located in
    120 directory test/.libs/. While this allows us to dynamically link against
    121 the temporary library in yat/, it makes straightforward usage of GDB
     118If shared library is enabled (default), Libtool creates wrapper
     119scripts in directory `test/` that call the test programs located in
     120directory `test/.libs/`. While this allows us to dynamically link against
     121the temporary library in `yat/`, it makes straightforward usage of GDB
    122122impossible. For that reason libtool provides a wrapper:
    123123
     
    131131= Versioning =
    132132
    133 We use a softened version of [http://apr.apache.org/versioning.html APR guidelines] which
    134 in short implies
     133We use a softened version of
     134[http://apr.apache.org/versioning.html APR guidelines] which in short implies
    135135
    136136''"The basic intent is that '''`MAJOR`''' versions are incompatible,
    137 large-scale upgrades of the API. '''`MINOR`''' versions retain compatibility with older minor versions, and changes in the
    138 '''`PATCH`''' level are perfectly compatible, forwards and backwards."''
     137large-scale upgrades of the API. '''`MINOR`''' versions retain
     138compatibility with older minor versions, and changes in the
     139'''`PATCH`''' level are perfectly compatible, forwards and
     140backwards."''
    139141
    140142== '''`MAJOR`''' Releases ==
Note: See TracChangeset for help on using the changeset viewer.