From 50bbc2bd6bda89f8a7a0bdd30c58ab8ba09c9b1f Mon Sep 17 00:00:00 2001 From: Mark Olesen <Mark.Olesen@esi-group.com> Date: Fri, 7 Jun 2019 13:43:27 +0200 Subject: [PATCH] DOC: cross-reference readme/build/requirements --- README.md | 30 +++++++++++++++++++++++++++++- doc/Requirements.md | 2 +- 2 files changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 60fe7d3c035..50867beee7d 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,34 @@ Please [contact OpenCFD](http://www.openfoam.com/contact) if you have any questi Violations of the Trademark are continuously monitored, and will be duly prosecuted. +# Compiling OpenFOAM + +Please see the relevant guides: + +| Location | Readme | Requirements | Build | +|-------------|-----------|--------------|-------| +| [OpenFOAM][repo openfoam] | [readme][link openfoam-readme] | [system requirements][link openfoam-require] | [build][link openfoam-build] | +| [ThirdParty][repo third] | [readme][link third-readme] | [system requirements][link third-require] | [build][link third-build] | + + + +<!-- OpenFOAM --> + +[repo openfoam]: https://develop.openfoam.com/Development/OpenFOAM-plus/ +[repo third]: https://develop.openfoam.com/Development/ThirdParty-plus/ + +[link openfoam-readme]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/README.md +[link openfoam-issues]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/BuildIssues.txt +[link openfoam-build]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/BUILD.md +[link openfoam-config]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/etc/README.md +[link openfoam-require]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/Requirements.md +[link third-build]: https://develop.openfoam.com/Development/ThirdParty-plus/blob/develop/BUILD.md +[link third-require]: https://develop.openfoam.com/Development/ThirdParty-plus/blob/develop/Requirements.md +[link third-readme]: https://develop.openfoam.com/Development/ThirdParty-plus/blob/develop/README.md + +[link third-party]: https://develop.openfoam.com/Development/ThirdParty-plus/ + + # Useful Links - [Download and installation instructions](http://www.openfoam.com/download/) - [Documentation](http://www.openfoam.com/documentation) @@ -24,4 +52,4 @@ Violations of the Trademark are continuously monitored, and will be duly prosecu - [OpenFOAM Community](http://www.openfoam.com/community/) - [Contacting OpenCFD](http://www.openfoam.com/contact/) -Copyright 2016-2018 OpenCFD Ltd +Copyright 2016-2019 OpenCFD Ltd diff --git a/doc/Requirements.md b/doc/Requirements.md index 1ddf73f0fb8..693f8866afa 100644 --- a/doc/Requirements.md +++ b/doc/Requirements.md @@ -145,7 +145,7 @@ export LD_PRELOAD="libmpi.so" When compiled ParaView from source additional dependencies will be required. -A partial list is given in the [ThirdParty requirements][third-require]. +A partial list is given in the [ThirdParty requirements][link third-require]. **Please help us with keeping that information up-to-date and accurate.** <!-- Links --> -- GitLab