diff --git a/README.md b/README.md new file mode 100644 index 00000000..a7ffde1c --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +SW4 - Seismic Waves, 4th order accuracy +=========================================================== +[![License GPL2+:](https://img.shields.io/badge/License-GPL%202%2B-red)](https://github.com/geodynamics/sw4/blob/master/LICENSE.txt) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8322590.svg)](https://doi.org/10.5281/zenodo.8322590) +[![pdf manual](https://img.shields.io/badge/get-PDF-green.svg)](https://github.com/geodynamics/sw4/blob/master/doc/SW4_UsersGuide.pdf) + +More information +---------------- +Please see the [Users Guide](https://github.com/geodynamics/sw4/blob/master/doc/SW4_UsersGuide.pdf) for more information regarding the use of SW4. + +Additional resources: +- [SW4](https://geodynamics.org/resources/sw4/about) +- [Forum](https://community.geodynamics.org/c/sw4/32) + + +Files +----- + +- LICENCE.txt - GNU General Public Licence version 2 +- INSTALL.txt - Information on how to build SW4 +- README.txt - This file! +- wave.txt - Text file containing the "SW4 Lives" banner +- Makefile - Main makefile + +Directories +----------- +- configs/ - Directory containing configuration files for "make" +- src/ - C++ and Fortran source code for SW4 +- tools/ - Matlab/Octave scripts for post processing and analysis of results +- examples/ - Sample SW4 input files +- optimize/ - Directory for object files and the optimized SW4 executable +- debug/ - Directory for object files and a SW4 executable with debug symbols + +License +------- + +SW4 is published under [GPL v2 or newer](LICENSE.txt). + + diff --git a/README.txt b/README.txt deleted file mode 100644 index 8a0dbe1b..00000000 --- a/README.txt +++ /dev/null @@ -1,28 +0,0 @@ -SW4 - Seismic Waves, 4th order accuracy - -Please see the Users Guide for more information regarding the use of SW4. - -Files and directories: - -LICENCE.txt GNU General Public Licence version 2 -INSTALL.txt Information on how to build SW4 -README.txt This file! -Makefile Main makefile -CMakeLists.txt Cmake build rules -wave.txt Text file containing the "SW4 Lives" banner - -build Directory for building SW4 with "cmake" -configs Directory containing configuration files for "make" -debug Directory for object files and a SW4 executable with debug symbols -doc Directory holding the user's guide and installation instructions -examples Sample SW4 input files -inverse Directory with some test cases and documentation for sw4mopt -optimize Directory for object files and the optimized SW4 executable -performance Directory for testing SW4 run time performance -pytest Directory for testing SW4 correctness -pytest-sw4mopt Directory for testing sw4mopt -src C++ and Fortran source code for SW4 -tools Python/Matlab/Octave scripts for post processing and analysis of results - - -For more info, contact: Computational Infrastructure for Geodynamics (CIG) {\tt geodynamics.org}.