aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorlangou <julien.langou@ucdenver.edu>2017-01-04 12:05:27 +0100
committerGitHub <noreply@github.com>2017-01-04 12:05:27 +0100
commitafa00184cdf939db722d861978893c9ec9d3f039 (patch)
tree4c38c35eb0e5ad1a303b2e24566b8b98290d0c2e
parentb5144a4ca1830ab349296ec141e877651ce08332 (diff)
parent4ffa8851694d8268938f86b811a19066dd18691d (diff)
downloadlapack-afa00184cdf939db722d861978893c9ec9d3f039.tar.gz
Merge pull request #108 from nschloe/readme-markdown
Readme markdown
-rw-r--r--README.md (renamed from README)130
1 files changed, 56 insertions, 74 deletions
diff --git a/README b/README.md
index c22b7d29..08649294 100644
--- a/README
+++ b/README.md
@@ -1,30 +1,29 @@
-==================
-LAPACK README FILE
-==================
-
-VERSION 1.0 : February 29, 1992
-VERSION 1.0a : June 30, 1992
-VERSION 1.0b : October 31, 1992
-VERSION 1.1 : March 31, 1993
-VERSION 2.0 : September 30, 1994
-VERSION 3.0 : June 30, 1999
-VERSION 3.0 + update : October 31, 1999
-VERSION 3.0 + update : May 31, 2000
-VERSION 3.1 : November 2006
-VERSION 3.1.1 : February 2007
-VERSION 3.2 : November 2008
-VERSION 3.2.1 : April 2009
-VERSION 3.2.2 : June 2010
-VERSION 3.3.0 : November 2010
-VERSION 3.3.1 : April 2011
-VERSION 3.4.0 : November 2011
-VERSION 3.4.1 : April 2012
-VERSION 3.4.2 : September 2012
-VERSION 3.5.0 : November 2013
-VERSION 3.6.0 : November 2015
-VERSION 3.6.1 : June 2016
-VERSION 3.7.0 : December 2016
-
+# LAPACK
+
+[![Build Status](https://travis-ci.org/Reference-LAPACK/lapack.svg?branch=master)](https://travis-ci.org/Reference-LAPACK/lapack)
+
+* VERSION 1.0 : February 29, 1992
+* VERSION 1.0a : June 30, 1992
+* VERSION 1.0b : October 31, 1992
+* VERSION 1.1 : March 31, 1993
+* VERSION 2.0 : September 30, 1994
+* VERSION 3.0 : June 30, 1999
+* VERSION 3.0 + update : October 31, 1999
+* VERSION 3.0 + update : May 31, 2000
+* VERSION 3.1 : November 2006
+* VERSION 3.1.1 : February 2007
+* VERSION 3.2 : November 2008
+* VERSION 3.2.1 : April 2009
+* VERSION 3.2.2 : June 2010
+* VERSION 3.3.0 : November 2010
+* VERSION 3.3.1 : April 2011
+* VERSION 3.4.0 : November 2011
+* VERSION 3.4.1 : April 2012
+* VERSION 3.4.2 : September 2012
+* VERSION 3.5.0 : November 2013
+* VERSION 3.6.0 : November 2015
+* VERSION 3.6.1 : June 2016
+* VERSION 3.7.0 : December 2016
LAPACK is a library of Fortran 90 with subroutines for solving
the most commonly occurring problems in numerical linear algebra.
@@ -43,27 +42,25 @@ intended for use only if there is no other implementation of the BLAS
already available on your machine; the efficiency of LAPACK depends
very much on the efficiency of the BLAS.
-=================
-LAPACK INSTALLATION:
- - LAPACK can be installed with make. Configuration have to be set in the
- make.inc file. A make.inc.example for a Linux machine running GNU compilers
- is given in the main directory. Some specific make.inc are also available in
- the INSTALL directory
- - LAPACK includes also the CMAKE build. You will need to have CMAKE installed
- on your machine (CMAKE is available at http://www.cmake.org/). CMAKE will allow
- an easy installation on a Windows Machine
+## Installation
+
+ - LAPACK can be installed with `make`. Configuration have to be set in the
+ `make.inc` file. A `make.inc.example` for a Linux machine running GNU compilers
+ is given in the main directory. Some specific `make.inc` are also available in
+ the `INSTALL` directory.
+ - LAPACK includes also the CMake build. You will need to have CMake installed
+ on your machine (CMake is available at http://www.cmake.org/). CMake will
+ allow an easy installation on a Windows Machine.
- Specific information to run LAPACK under Windows are available at
- http://icl.cs.utk.edu/lapack-for-windows/lapack/
+ http://icl.cs.utk.edu/lapack-for-windows/lapack/.
For further information on LAPACK please read our FAQ at
http://www.netlib.org/lapack/#_faq
A User forum is also available to help you with the LAPACK library at
http://icl.cs.utk.edu/lapack-forum/
-================
-================
-LAPACK User Support
+## User Support
LAPACK has been thoroughly tested, on many different
types of computers. The LAPACK project supports the package in the
@@ -74,16 +71,15 @@ electronic mail to lapack@cs.utk.edu.
A list of known problems, bugs, and compiler errors for LAPACK is
maintained on netlib.
- http://www.netlib.org/lapack/release_notes.html
+ * http://www.netlib.org/lapack/release_notes.html
A User forum is also available to help you with the LAPACK library at
- http://icl.cs.utk.edu/lapack-forum/
-You can also contact directly the LAPACK team at lapack@cs.utk.edu
-================
+ http://icl.cs.utk.edu/lapack-forum/.
+You can also contact directly the LAPACK team at lapack@cs.utk.edu.
-================
-LAPACK TESTING
+## Testing
+
The complete package, including test code in four
different Fortran data types (real, complex, double precision, double
complex), contains some 805,000 lines of Fortran source and comments.
@@ -94,17 +90,16 @@ types, including the object files, is approximately 80 Mbytes.
A README file containing the information in this letter is located
in the LAPACK directory. Postscript and LaTeX versions of the Quick
-Installation Guide are in the LAPACK/INSTALL directory, in the files
-lawn81.tex, psfig.tex, lawn81.ps, and org2.ps. Consult the Installation
+Installation Guide are in the `LAPACK/INSTALL` directory, in the files
+`lawn81.tex`, `psfig.tex`, `lawn81.ps`, and `org2.ps`. Consult the Installation
Guide for further details on installing the package and on what is contained
in each subdirectory. For complete information on the LAPACK Testing
please consult LAPACK Working Note 41 "Installation
Guide for LAPACK".
-================
-================
-LAPACK USER GUIDE
+## User Guide
+
It is highly recommended that you obtain a copy of the Third Edition of
the LAPACK Users' Guide published by SIAM in Winter, 1999. This Users'
Guide gives a detailed description of the philosophy behind LAPACK as well
@@ -120,55 +115,42 @@ price for SIAM members is $31.20; the cost for nonmembers is $39.00.
To view an HTML version of the Users' Guide please refer to the URL
http://www.netlib.org/lapack/lug/lapack_lug.html.
-================
-================
-LAPACKE
+## LAPACKE
LAPACK now includes the LAPACKE package
LAPACKE is a Standard C language APIs for LAPACK
http://www.netlib.org/lapack/#_standard_c_language_apis_for_lapack
collaboration LAPACK and INTEL Math Kernel Library
Documentation available in the DOCS folder
-================
-================
-RELATED LAPACK PROJECTS
+## Related Projects
The Fortran95 interface to LAPACK is available, as well as an f2c'ed
version of LAPACK, and a C++ version of a subset of LAPACK routines.
Refer to the following URLs on netlib for further information:
- http://www.netlib.org/lapack95/
- http://www.netlib.org/clapack/
- http://www.netlib.org/lapack++/
- http://www.cs.utk.edu/java/f2j/
+ * http://www.netlib.org/lapack95/
+ * http://www.netlib.org/clapack/
+ * http://www.netlib.org/lapack++/
+ * http://www.cs.utk.edu/java/f2j/
Or, for more information on the distributed-memory version of LAPACK,
consult the ScaLAPACK index on netlib:
http://www.netlib.org/scalapack/
-================
-================
-LAPACK WORKING NOTES
+## Working Notes
A number of technical reports were written during the development of
LAPACK and published as LAPACK Working Notes, initially by Argonne
National Laboratory and later by the University of Tennessee. Many of
these reports later appeared as journal articles. Most of these working
notes are available in pdf and postscript form from netlib.
- http://www.netlib.org/lapack/lawns/
- http://www.netlib.org/lapack/lawnspdf/
+ * http://www.netlib.org/lapack/lawns/
+ * http://www.netlib.org/lapack/lawnspdf/
Otherwise, requests for copies of these working notes can be sent to
the following address.
-LAPACK Project
-c/o J.J. Dongarra
-Computer Science Department
-University of Tennessee
-Knoxville, Tennessee 37996-1301
-USA
-Email: lapack@cs.utk.edu
-================
+LAPACK Project, c/o J.J. Dongarra, Computer Science Department, University of Tennessee, Knoxville, Tennessee 37996-1301, USA, Email: lapack@cs.utk.edu.