Sync usage with man page.
[netbsd-mini2440.git] / lib / libc / softfloat / README.txt
blobbd1e43955d3bfc9adf0fb227ca8e6835b28d204c
1 $NetBSD$
3 Package Overview for SoftFloat Release 2a
5 John R. Hauser
6 1998 December 13
9 SoftFloat is a software implementation of floating-point that conforms to
10 the IEC/IEEE Standard for Binary Floating-Point Arithmetic.  SoftFloat is
11 distributed in the form of C source code.  Compiling the SoftFloat sources
12 generates two things:
14 -- A SoftFloat object file (typically `softfloat.o') containing the complete
15    set of IEC/IEEE floating-point routines.
17 -- A `timesoftfloat' program for evaluating the speed of the SoftFloat
18    routines.  (The SoftFloat module is linked into this program.)
20 The SoftFloat package is documented in four text files:
22    softfloat.txt          Documentation for using the SoftFloat functions.
23    softfloat-source.txt   Documentation for compiling SoftFloat.
24    softfloat-history.txt  History of major changes to SoftFloat.
25    timesoftfloat.txt      Documentation for using `timesoftfloat'.
27 Other files in the package comprise the source code for SoftFloat.
29 Please be aware that some work is involved in porting this software to other
30 targets.  It is not just a matter of getting `make' to complete without
31 error messages.  I would have written the code that way if I could, but
32 there are fundamental differences between systems that I can't make go away.
33 You should not attempt to compile SoftFloat without first reading both
34 `softfloat.txt' and `softfloat-source.txt'.
36 At the time of this writing, the most up-to-date information about
37 SoftFloat and the latest release can be found at the Web page `http://
38 HTTP.CS.Berkeley.EDU/~jhauser/arithmetic/SoftFloat.html'.