ENH: Added ReleaseNotes, ChangeLog and INSTALL
[freefoam.git] / ReleaseNotes.html
blob772dfc324447c2859b1bb1ac554421a41fc56d1c
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.4.4" />
7 <title>Release Notes for FreeFOAM version 0.1.0rc1</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revision {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 div.imageblock img { border: 1px solid silver; }
213 span.image img { border-style: none; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
248 div.compact ul, div.compact ol,
249 div.compact p, div.compact p,
250 div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Workarounds for IE6's broken and incomplete CSS2. */
344 div.sidebar-content {
345 background: #ffffee;
346 border: 1px solid silver;
347 padding: 0.5em;
349 div.sidebar-title, div.image-title {
350 color: #527bbd;
351 font-family: sans-serif;
352 font-weight: bold;
353 margin-top: 0.0em;
354 margin-bottom: 0.5em;
357 div.listingblock div.content {
358 border: 1px solid silver;
359 background: #f4f4f4;
360 padding: 0.5em;
363 div.quoteblock-attribution {
364 padding-top: 0.5em;
365 text-align: right;
368 div.verseblock-content {
369 white-space: pre;
371 div.verseblock-attribution {
372 padding-top: 0.75em;
373 text-align: left;
376 div.exampleblock-content {
377 border-left: 2px solid silver;
378 padding-left: 0.5em;
381 /* IE6 sets dynamically generated links as visited. */
382 div#toc a:visited { color: blue; }
383 </style>
384 <script type="text/javascript">
385 /*<![CDATA[*/
386 window.onload = function(){generateToc(2)}
387 /* Author: Mihai Bazon, September 2002
388 * http://students.infoiasi.ro/~mishoo
390 * Table Of Content generator
391 * Version: 0.4
393 * Feel free to use this script under the terms of the GNU General Public
394 * License, as long as you do not remove or alter this notice.
397 /* modified by Troy D. Hanson, September 2006. License: GPL */
398 /* modified by Stuart Rackham, October 2006. License: GPL */
400 function getText(el) {
401 var text = "";
402 for (var i = el.firstChild; i != null; i = i.nextSibling) {
403 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
404 text += i.data;
405 else if (i.firstChild != null)
406 text += getText(i);
408 return text;
411 function TocEntry(el, text, toclevel) {
412 this.element = el;
413 this.text = text;
414 this.toclevel = toclevel;
417 function tocEntries(el, toclevels) {
418 var result = new Array;
419 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
420 // Function that scans the DOM tree for header elements (the DOM2
421 // nodeIterator API would be a better technique but not supported by all
422 // browsers).
423 var iterate = function (el) {
424 for (var i = el.firstChild; i != null; i = i.nextSibling) {
425 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
426 var mo = re.exec(i.tagName)
427 if (mo)
428 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
429 iterate(i);
433 iterate(el);
434 return result;
437 // This function does the work. toclevels = 1..4.
438 function generateToc(toclevels) {
439 var toc = document.getElementById("toc");
440 var entries = tocEntries(document.getElementsByTagName("body")[0], toclevels);
441 for (var i = 0; i < entries.length; ++i) {
442 var entry = entries[i];
443 if (entry.element.id == "")
444 entry.element.id = "toc" + i;
445 var a = document.createElement("a");
446 a.href = "#" + entry.element.id;
447 a.appendChild(document.createTextNode(entry.text));
448 var div = document.createElement("div");
449 div.appendChild(a);
450 div.className = "toclevel" + entry.toclevel;
451 toc.appendChild(div);
453 if (entries.length == 0)
454 document.getElementById("header").removeChild(toc);
456 /*]]>*/
457 </script>
458 </head>
459 <body>
460 <div id="header">
461 <h1>Release Notes for FreeFOAM version 0.1.0rc1</h1>
462 <span id="author">Michael Wild</span><br />
463 <span id="email"><tt>&lt;<a href="mailto:themiwi@users.sourceforge.net">themiwi@users.sourceforge.net</a>&gt;</tt></span><br />
464 <span id="revision">version 0.1.0rc1,</span>
465 15 May 2009
466 <div id="toc">
467 <div id="toctitle">Table of Contents</div>
468 <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
469 </div>
470 </div>
471 <div id="preamble">
472 <div class="sectionbody">
473 <div class="paragraph"><p><a href="http://freefoam.sourceforge.net">http://freefoam.sourceforge.net</a></p></div>
474 <div class="paragraph"><p>FreeFOAM is a cross-platform toolkit for computational fluid dynamics (CFD)
475 based on <a href="http://openfoam.org">OpenFOAM&#174;</a>. It is geared towards "freeing"
476 OpenFOAM from its system dependence, enabling it to run natively on a variety
477 of operating systems. Currently it still requires a Unix-like environment.
478 FreeFOAM has been tested to build (and partially to run) on</p></div>
479 <div class="ulist"><ul>
480 <li>
482 <a href="http://www.debian.org">Debian GNU/Linux</a> 4.0
483 </p>
484 </li>
485 <li>
487 <a href="http://www.opensuse.org">OpenSUSE</a> 10.3
488 </p>
489 </li>
490 <li>
492 <a href="http://www.centos.org">CentOS</a> 5.2 (running on a
493 <a href="http://www.rocksclusters.org">Rocks Cluster</a> 5.1)
494 </p>
495 </li>
496 <li>
498 <a href="http://www.apple.com/macosx">Mac OS X</a> 10.5 Leopard&#174;
499 </p>
500 </li>
501 </ul></div>
502 <div class="paragraph"><p>FreeFOAM uses the excellent cross-platform build system
503 <a href="http://cmake.org">CMake</a> thanks to which FreeFOAM can now be installed just like
504 any other software and doesn&#8217;t depend on a slew of shell init scripts and a
505 huge number of environment variables to build and run, making live easier for
506 system administrators and users alike.</p></div>
507 <div class="paragraph"><p>This release candidate 1 of FreeFOAM 0.1.0 is only intended for testing
508 purposes. Refer to the enclosed <a href="README.html">README</a> file for
509 installation and usage instructions.</p></div>
510 <div class="paragraph"><p>For an overview of the changes and new features added to FreeFOAM, consult the
511 <a href="ChangeLog.html">ChangeLog</a> file. For the detailed list of changes, refer
512 to the log provided by the <a href="http://repo.or.cz/w/freefoam.git">FreeFOAM GIT
513 repository</a>.</p></div>
514 <div class="paragraph"><p>If you have questions or think you found a bug, please subscribe and post to
515 the <a href="http://freefoam.wiki.sourceforge.net/MailingLists">FreeFOAM-users mailing
516 list</a>.</p></div>
517 <div class="paragraph"><p>This release builds upon revision <a href="http://repo.or.cz/w/OpenFOAM-1.5.x.git?a=commit;h=ea39ad">ea39ad</a> (12 May 2009) of
518 the official OpenCFD&#174; patch releases repository for OpenFOAM 1.5.x.</p></div>
519 <hr />
520 <div class="paragraph"><p><a href="http://openfoam.org">OpenFOAM&#174;</a> is a registered trademark of
521 <a href="http://opencfd.co.uk">OpenCFD&#174; Ltd.</a></p></div>
522 <div class="paragraph"><p><a href="http://apple.com/macosx">Mac OS X Leopard&#174;</a> is a registered trademark of
523 <a href="http://apple.com">Apple&#174; Inc.</a></p></div>
524 </div>
525 </div>
526 <div id="footer">
527 <div id="footer-text">
528 Version 0.1.0rc1<br />
529 Last updated 2009-05-15 10:38:57 CEST
530 </div>
531 </div>
532 </body>
533 </html>