Skip to content

Commit

Permalink
Merge pull request #757 from MFraters/update_readme_v1.0.0
Browse files Browse the repository at this point in the history
Update readme for v1.0.0
  • Loading branch information
MFraters authored Aug 28, 2024
2 parents 60a74b5 + cd245a3 commit 78b6a18
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ For more information see the [GWB site](https://geodynamicworldbuilder.github.io

## Frequently Asked Questions (FAQ)
### What are the minimum requirements to compile the library and tools?
For GWB version 0.6.0 only a C++14 compiler and CMake version higher than 2.8.12 are required to compile the library tools. Note that for some optional features (such as certain wrappers and unity build) a higher version of CMake and other dependencies may be needed (e.g., a Fortran compiler to compile the Fortran wrapper).
Currently, GWB requires only a C++14 compiler and CMake version higher than 2.8.12 to compile the library tools. Note that for some optional features (such as certain wrappers and unity build) a higher version of CMake and other dependencies may be needed (e.g., a Fortran compiler to compile the Fortran wrapper).
### What do I do when I have a question or want to request a feature?
If you have a question about the code and you can not find the answer easily in the documentation or the question is not already raised as an [issue](https://github.com/GeodynamicWorldBuilder/WorldBuilder/issues), please let us know by opening an [issue on github](https://github.com/GeodynamicWorldBuilder/WorldBuilder/issues/new). This is also the preferred method for asking for new features for GWB.

Expand All @@ -36,11 +36,13 @@ Feel free to join!
### How to cite?
The developers of the Geodynamic World Builder request that you cite the following publication:

Fraters, M., Billen, M., Gassmöller, R., Saxena, A., Heister, T., Li, H., Douglas, D., Dannberg J., Bangerth W. and Wang, Y.: The Geodynamic World Builder: A planetary structure creator for the geosciences, Journal of Open Source Software, [https://doi.org/10.21105/joss.06671](https://doi.org/10.21105/joss.06671), 2024.

Fraters, M., Thieulot, C., van den Berg, A., and Spakman, W.: The Geodynamic World Builder: a solution for complex initial conditions in numerical modelling, Solid Earth, [https://doi.org/10.5194/se-10-1785-2019](https://doi.org/10.5194/se-10-1785-2019), 2019.

And cite the specific version of the software used. Version 0.6.0 can be cited as:
And cite the specific version of the software used. The current release can be cited as:

Menno Fraters and others. 2024, March 8. The Geodynamic World Builder v0.6.0. Zenodo. [https://doi.org/10.5281/zenodo.10794862](https://doi.org/10.5281/zenodo.10794862).
Menno Fraters and others. August 2024. The Geodynamic World Builder v1.0.0. Zenodo. [https://doi.org/10.5281/zenodo.13352667](https://doi.org/10.5281/zenodo.13352667).

### How can I follow the progress of this project?
There are multiple ways in which you can follow this project:
Expand Down

0 comments on commit 78b6a18

Please sign in to comment.