Changeset 2404 for trunk/README.developer

Timestamp:

Jan 12, 2011, 3:37:21 AM (12 years ago)

Author:

Peter

Message:

improve readability and some minor changes of the text

File:

• trunk/README.developer (modified) (5 diffs)

trunk/README.developer

@@ -14 +14 @@
 (`make` and `make check`) when someone makes a clean checkout. There
 is a short introduction to subversion and its usage available as
-[http://cbbp.thep.lu.se/~jari/documents/subversion_guidelines/index.html
-Subversion guidelines]. We follow these guidelines.
+[http://cbbp.thep.lu.se/~jari/documents/subversion_guidelines/index.html Subversion guidelines]. 
+We follow these guidelines.
 
 === Testing ===
@@ -33 +33 @@
 
 The GSL documentation describes how
-[http://www.gnu.org/software/gsl/manual/html_node/Error-Handling.html#Error-Handling GSL error handling]
+[http://www.gnu.org/software/gsl/manual/html_node/Error-Handling.html GSL error handling]
 works. The GSL library follows the thread-safe
 error reporting conventions of the posix Threads library. That is,
@@ -100 +100 @@
 == Requirements ==
 
-To build from a subversion checkout, you will need Autotools. More
+To build from a subversion checkout, you will need GNU Autotools. More
 specifically 
- * Automake 1.11 (or later)
- * Autoconf 2.63 (or later)
- * Libtool.
+ * Automake 1.11 (or later), http://www.gnu.org/software/automake/
+ * Autoconf 2.63 (or later), http://www.gnu.org/software/automake/
+ * Libtool 1.5 (or later), http://www.gnu.org/software/libtool/
 
 == Disable shared library ==
 
-yat uses gnu Libtool in order to build shared libraries on a variety
+yat uses GNU Libtool in order to build shared libraries on a variety
 of systems.  While this is very nice for making usable binaries, it
 can be a pain when trying to debug a program. For that reason,
@@ -116 +116 @@
 == Debugging using GDB ==
 
-If shared library is enabled (default), libtool creates wrapper
-scripts in directory test/ that call the test programs located in
-directory test/.libs/. While this allows us to dynamically link against
-the temporary library in yat/, it makes straightforward usage of GDB
+If shared library is enabled (default), Libtool creates wrapper
+scripts in directory `test/` that call the test programs located in
+directory `test/.libs/`. While this allows us to dynamically link against
+the temporary library in `yat/`, it makes straightforward usage of GDB
 impossible. For that reason libtool provides a wrapper:
 
@@ -131 +131 @@
 = Versioning =
 
-We use a softened version of [http://apr.apache.org/versioning.html APR guidelines] which
-in short implies
+We use a softened version of 
+[http://apr.apache.org/versioning.html APR guidelines] which in short implies
 
 ''"The basic intent is that '''`MAJOR`''' versions are incompatible,
-large-scale upgrades of the API. '''`MINOR`''' versions retain compatibility with older minor versions, and changes in the
-'''`PATCH`''' level are perfectly compatible, forwards and backwards."''
+large-scale upgrades of the API. '''`MINOR`''' versions retain
+compatibility with older minor versions, and changes in the
+'''`PATCH`''' level are perfectly compatible, forwards and
+backwards."''
 
 == '''`MAJOR`''' Releases ==