ENH: Revamped docs generation
[freefoam.git] / README-OpenFOAM.org
blobaa1129bfffaeb9aa011bbc85876d5475b4a5ab69
1 #                            -*- mode: org; -*-
3 #+TITLE:     OpenFOAM README for version 1.7.1
4 #+AUTHOR:                      OpenCFD Ltd.
5 #+DATE:                     26th August 2010
6 #+LINK:                   http://www.openfoam.com
7 #+OPTIONS: author:nil ^:{}
8 # Copyright (c) 2010 OpenCFD Ltd.
10 * About OpenFOAM
11   OpenFOAM is a free, open source computational fluid dynamcis (CFD) software
12   package produced by a commercial company, OpenCFD Ltd. It has a large user
13   base across most areas of engineering and science, from both commercial and
14   academic organisations. OpenFOAM has an extensive range of features to solve
15   anything from complex fluid flows involving chemical reactions, turbulence and
16   heat transfer, to solid dynamics and electromagnetics.
18 * Copyright
19   OpenFOAM is free software: you can redistribute it and/or modify it under the
20   terms of the GNU General Public License as published by the Free Software
21   Foundation, either version 3 of the License, or (at your option) any later
22   version.  See the file =COPYING= in this directory or
23   [[http://www.gnu.org/licenses/]], for a description of the GNU General Public
24   License terms under which you can copy the files.
26 * Download and installation instructions
27   + To install the Ubuntu/Debian (.deb) pack, see
28     [[http://www.OpenFOAM.com/download/ubuntu.php]]
29   + To install the source (.gtgz) pack, see
30     [[http://www.OpenFOAM.com/download/source.php]]
31   + To install from the Git repository, see
32     [[http://www.OpenFOAM.com/download/git.php]]
34 * Documentation
35   [[http://www.OpenFOAM.com/docs]]
37 * Support and development contracts
38   [[http://www.OpenFOAM.com/support]]
40 * Reporting Bugs in OpenFOAM
41   [[http://www.OpenFOAM.com/bugs]]