DOC: Updated and simplified HACKING
[freefoam.git] / ReleaseNotes
blobffd6d0350e8dc8e634b43faf2004e961bda5ba04
1 Release Notes for FreeFOAM version {fullver}
2 ============================================
3 Michael Wild <themiwi@users.sourceforge.net>
4 v{fullver}, {localdate}
5 :Author Initials: MW
6 :linkcss!:
7 http://freefoam.sourceforge.net
9 FreeFOAM is a cross-platform toolkit for computational fluid dynamics (CFD)
10 based on http://openfoam.org[OpenFOAM(R)]. It is geared towards "freeing"
11 OpenFOAM from its system dependence, enabling it to run natively on a variety
12 of operating systems. Currently it still requires a Unix-like environment.
13 FreeFOAM has been tested to build (and partially to run) on
15 * http://www.debian.org[Debian GNU/Linux] 4.0
16 * http://www.opensuse.org[OpenSUSE] 10.3
17 * http://www.centos.org[CentOS] 5.2 (running on a
18   http://www.rocksclusters.org[Rocks Cluster] 5.1)
19 * http://www.apple.com/macosx[Mac OS X] 10.5 Leopard(R)
21 FreeFOAM uses the excellent cross-platform build system
22 http://cmake.org[CMake] thanks to which FreeFOAM can now be installed just like
23 any other software and doesn't depend on a slew of shell init scripts and a
24 huge number of environment variables to build and run, making live easier for
25 system administrators and users alike.
27 This release candidate 4 of FreeFOAM {ver} is only intended for testing
28 purposes. Refer to the enclosed link:README.html[README] file for
29 installation and usage instructions.
31 For an overview of the changes and new features added to FreeFOAM, consult the
32 link:ChangeLog.html[ChangeLog] file. For the detailed list of changes, refer
33 to the log provided by the http://repo.or.cz/w/freefoam.git[FreeFOAM GIT
34 repository].
36 If you have questions or think you found a bug, please subscribe and post to
37 the http://freefoam.wiki.sourceforge.net/MailingLists[FreeFOAM-users mailing
38 list].
40 This release builds upon revision linkrepo:openfoam[3f1dda] (2009-06-24) of
41 the official OpenCFD(R) patch releases repository for OpenFOAM 1.5.x.
43 ''''''''''''''''''''''''''''
44 http://openfoam.org[OpenFOAM(R)] is a registered trademark of
45 http://opencfd.co.uk[OpenCFD(R) Ltd.]
47 http://apple.com/macosx[Mac OS X Leopard(R)] is a registered trademark of
48 http://apple.com[Apple(R) Inc.]
50 /////////////////////////////////////////////////////////////////////////
51 Process with: asciidoc -a toc -f data/asciidoc/html.conf ReleaseNotes
53 Vim users, this is for you:
54 vim: ft=asciidoc sw=2 expandtab fenc=utf-8
55 /////////////////////////////////////////////////////////////////////////