diff --git a/README b/README.md similarity index 53% rename from README rename to README.md index 7bc222faae59e3aaf0919ab35cc18bbd2df2d6d8..64e391132cd9a8d221857e6efd7283df83a7d2ae 100644 --- a/README +++ b/README.md @@ -1,4 +1,14 @@ -The Darshan source tree is divided into two parts: +Darshan is a lightweight I/O characterization tool that transparently +captures I/O access pattern information from HPC applications. +Darshan can be used to tune applications for increased scientific +productivity or to gain insight into trends in large-scale computing +systems. + +Please see the +[Darshan web page](https://www.mcs.anl.gov/research/projects/darshan) +for more in-depth news and documentation. + +The Darshan source tree is divided into two main parts: - darshan-runtime: to be installed on systems where you intend to instrument MPI applications. See darshan-runtime/doc/darshan-runtime.txt @@ -8,9 +18,6 @@ The Darshan source tree is divided into two parts: log files produced by darshan-runtime. See darshan-util/doc/darshan-util.txt for installation instructions. -General documentation can be found on the Darshan documentation web page: -http://www.mcs.anl.gov/darshan/documentation/ - The darshan-test directory contains various test harnesses, benchmarks, patches, and unsupported utilites that are mainly of interest to Darshan developers.