Skip to content

Commit

Permalink
Merge pull request #199 from ljhwang/v3_readme
Browse files Browse the repository at this point in the history
Removes old README and replaces with markdown version
  • Loading branch information
andersp authored Oct 12, 2023
2 parents 13e6d43 + a58c49b commit 037ac3e
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 28 deletions.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).


28 changes: 0 additions & 28 deletions README.txt

This file was deleted.

0 comments on commit 037ac3e

Please sign in to comment.