-
Notifications
You must be signed in to change notification settings - Fork 65
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #199 from ljhwang/v3_readme
Removes old README and replaces with markdown version
- Loading branch information
Showing
2 changed files
with
39 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). | ||
|
||
|
This file was deleted.
Oops, something went wrong.