songtianlun/openfoam
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

STYLE: update README to v2312

Browse Source
This commit is contained in:
Mark Olesen 2023-12-12 18:00:40 +01:00
parent 4612238eff
commit 5b177b44f3
4 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitlab/issue_templates/bug.md
View File

@ -49,7 +49,7 @@
<!-- <!--
Providing details of your set-up can help us identify any issues, e.g. Providing details of your set-up can help us identify any issues, e.g.
OpenFOAM version : v2306|v2212|v2206|v2112|v2106 etc OpenFOAM version : v2312|v2306|v2212|v2206|v2112 etc
Operating system : ubuntu|openSUSE|centos etc Operating system : ubuntu|openSUSE|centos etc
Hardware info : any info that may help? Hardware info : any info that may help?
Compiler : gcc|intel|clang etc Compiler : gcc|intel|clang etc

16
README.md
View File

@ -40,9 +40,9 @@ Violations of the Trademark are monitored, and will be duly prosecuted.
If OpenFOAM has already been compiled on your system, simply source If OpenFOAM has already been compiled on your system, simply source
the appropriate `etc/bashrc` or `etc/cshrc` file and get started. the appropriate `etc/bashrc` or `etc/cshrc` file and get started.
For example, for the OpenFOAM-v2306 version: For example, for the OpenFOAM-v2312 version:
``` ```
source /installation/path/OpenFOAM-v2306/etc/bashrc source /installation/path/OpenFOAM-v2312/etc/bashrc
``` ```
## Compiling OpenFOAM ## Compiling OpenFOAM
@ -127,8 +127,8 @@ These 3rd-party sources are normally located in a directory parallel
to the OpenFOAM directory. For example, to the OpenFOAM directory. For example,
``` ```
/path/parent /path/parent
|-- OpenFOAM-v2306 |-- OpenFOAM-v2312
\-- ThirdParty-v2306 \-- ThirdParty-v2312
``` ```
There are, however, many cases where this simple convention is inadequate: There are, however, many cases where this simple convention is inadequate:
@ -136,7 +136,7 @@ There are, however, many cases where this simple convention is inadequate:
operating system or cluster installation provides it) operating system or cluster installation provides it)
* When we have changed the OpenFOAM directory name to some arbitrary * When we have changed the OpenFOAM directory name to some arbitrary
directory name, e.g. openfoam-sandbox2306, etc.. directory name, e.g. openfoam-sandbox2312, etc..
* When we would like any additional 3rd party software to be located * When we would like any additional 3rd party software to be located
inside of the OpenFOAM directory to ensure that the installation is inside of the OpenFOAM directory to ensure that the installation is
@ -156,9 +156,9 @@ when locating the ThirdParty directory with the following precedence:
2. PREFIX/ThirdParty-VERSION 2. PREFIX/ThirdParty-VERSION
* this corresponds to the traditional approach * this corresponds to the traditional approach
3. PREFIX/ThirdParty-vAPI 3. PREFIX/ThirdParty-vAPI
* allows for an updated value of VERSION, *eg*, `v2306-myCustom`, * allows for an updated value of VERSION, *eg*, `v2312-myCustom`,
without requiring a renamed ThirdParty. The API value would still without requiring a renamed ThirdParty. The API value would still
be `2306` and the original `ThirdParty-v2306/` would be found. be `2312` and the original `ThirdParty-v2312/` would be found.
4. PREFIX/ThirdParty-API 4. PREFIX/ThirdParty-API
* same as the previous example, but using an unadorned API value. * same as the previous example, but using an unadorned API value.
5. PREFIX/ThirdParty-common 5. PREFIX/ThirdParty-common
@ -213,4 +213,4 @@ ThirdParty directory will contain either an `Allwmake` file or a
- [Governance](http://www.openfoam.com/governance/), [Governance Projects](https://www.openfoam.com/governance/projects) - [Governance](http://www.openfoam.com/governance/), [Governance Projects](https://www.openfoam.com/governance/projects)
- [Contacting OpenCFD](http://www.openfoam.com/contact/) - [Contacting OpenCFD](http://www.openfoam.com/contact/)
Copyright 2016-2022 OpenCFD Ltd Copyright 2016-2023 OpenCFD Ltd

12
doc/Build.md
View File

@ -1,23 +1,23 @@
## Getting the code ## Getting the code
Links to all code packs are available on https://dl.openfoam.com. For OpenFOAM-v2306: Links to all code packs are available on https://dl.openfoam.com. For OpenFOAM-v2312:
- https://dl.openfoam.com/source/latest/ - https://dl.openfoam.com/source/latest/
- Source: https://dl.openfoam.com/source/v2306/OpenFOAM-v2306.tgz - Source: https://dl.openfoam.com/source/v2312/OpenFOAM-v2312.tgz
- ThirdParty: https://dl.openfoam.com/source/v2306/ThirdParty-v2306.tgz - ThirdParty: https://dl.openfoam.com/source/v2312/ThirdParty-v2312.tgz
## OpenFOAM&reg; Quick Build Guide ## OpenFOAM&reg; Quick Build Guide
Prior to building, ensure that the [system requirements][link openfoam-require] Prior to building, ensure that the [system requirements][link openfoam-require]
are satisfied (including any special [cross-compiling][wiki-cross-compile] are satisfied (including any special [cross-compiling][wiki-cross-compile]
considerations), and source the correct OpenFOAM environment. considerations), and source the correct OpenFOAM environment.
For example, for the OpenFOAM-v2306 version: For example, for the OpenFOAM-v2312 version:
``` ```
source <installation path>/OpenFOAM-v2306/etc/bashrc source <installation path>/OpenFOAM-v2312/etc/bashrc
``` ```
e.g. if installed under the `~/openfoam` directory e.g. if installed under the `~/openfoam` directory
``` ```
source ~/openfoam/OpenFOAM-v2306/etc/bashrc source ~/openfoam/OpenFOAM-v2312/etc/bashrc
``` ```

2
doc/BuildIssues.md
View File

@ -1,4 +1,4 @@
## Known Build Issues (v2306, v2212, v2206, v2112, v2106, v2012) ## Known Build Issues (v2312, v2306, v2212, v2206, v2112, v2106, v2012)
### Windows cross-compilation ### Windows cross-compilation