From 2d880ec53f108c9b7fc5f2044e6ec41be7654912 Mon Sep 17 00:00:00 2001 From: Miles Curry <2590700+MiCurry@users.noreply.github.com> Date: Tue, 8 Sep 2026 12:27:41 -0600 Subject: [PATCH 1/2] Move old branches section in Readme to branches section --- README.md | 36 +++++++++++++++++++----------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 5f6254e4..411e4d1e 100644 --- a/README.md +++ b/README.md @@ -10,27 +10,11 @@ Modular Electromagnetic Inversion Software (ModEM) [ModEM Documentation](https://magnetotellurics.github.io/ModEM/) -> **NOTE:** This repository has been converted from the ModEM's OSU CEOAS Subversion -> (SVN) repository. SVN revisions have been preserved and converted into Git -> commits. Some main branches have been renamed: -> -> | SVN Branch Name | GitHub Branch Name | -> | --------------- | -------------------| -> | trunk | [trunk][trunk-branch] | -> | stable- | [main][main-branch] | -> | stable | [classic][classic-branch] | -> -> Furthermore, the `matlab` and `examples` directory have been moved into the -> [ModEM-Tools][ModEM-Tools] and [ModEM-Examples][ModEM-Examples] repositories, -> respectively. - -[trunk-branch]: https://github.com/magnetotellurics/ModEM/tree/trunk -[main-branch]: https://github.com/magnetotellurics/ModEM/tree/main -[classic-branch]: https://github.com/magnetotellurics/ModEM/tree/classic # Contents * [Obtaining The Software](#obtaining-the-software) + * [Branches](#branches) * [Building ModEM](#building-modem) * [Dependencies](#dependencies) * [Creating Makefiles From Configuration files](#creating-makefiles-from-configuration-files) @@ -78,6 +62,24 @@ ModEM currently has two branches used for development: stable then develop. * [develop][develop-branch] - The branch that contains the newest code, that may be less stable than main and may contain bugs. + + +> **NOTE:** This repository has been converted from the ModEM's OSU CEOAS Subversion +> (SVN) repository. SVN revisions have been preserved and converted into Git +> commits. Some main branches have been renamed: +> +> | SVN Branch Name | GitHub Branch Name | +> | --------------- | -------------------| +> | stable- | [main][main-branch] | +> | stable | [classic][classic-branch] | +> +> Furthermore, the `matlab` and `examples` directory have been moved into the +> [ModEM-Tools][ModEM-Tools] and [ModEM-Examples][ModEM-Examples] repositories, +> respectively. + +[trunk-branch]: https://github.com/magnetotellurics/ModEM/tree/trunk +[main-branch]: https://github.com/magnetotellurics/ModEM/tree/main +[classic-branch]: https://github.com/magnetotellurics/ModEM/tree/classic [main-branch]: https://github.com/magnetotellurics/ModEM/ [develop-branch]: https://github.com/magnetotellurics/ModEM/tree/develop From 78c9b5674e6605e0453a31293d672c5949fa8c8d Mon Sep 17 00:00:00 2001 From: Miles Curry <2590700+MiCurry@users.noreply.github.com> Date: Tue, 8 Sep 2026 12:36:12 -0600 Subject: [PATCH 2/2] Create a small section linking to the ModEM docs --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 411e4d1e..38e420dc 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,13 @@ Modular Electromagnetic Inversion Software (ModEM) [![DOI](https://zenodo.org/badge/1025134680.svg)](https://doi.org/10.5281/zenodo.17229555) -[ModEM Documentation](https://magnetotellurics.github.io/ModEM/) # Contents * [Obtaining The Software](#obtaining-the-software) * [Branches](#branches) + * [ModEM Documentation](#modem-documentation) * [Building ModEM](#building-modem) * [Dependencies](#dependencies) * [Creating Makefiles From Configuration files](#creating-makefiles-from-configuration-files) @@ -84,6 +84,11 @@ ModEM currently has two branches used for development: [main-branch]: https://github.com/magnetotellurics/ModEM/ [develop-branch]: https://github.com/magnetotellurics/ModEM/tree/develop +## ModEM Documentation + +The ModEM Documentation can now be found online at: +https://magnetotellurics.github.io/ModEM/. + # Building ModEM ## Dependencies