boinc/doc/example.php

<?php
require_once("docutil.php");

page_head("Example applications");

echo "
Example applications are contained
in a separate CVS module, <b>boinc_samples</b>.
To build these applications:
<ul>
<li> <a href=source_code.php>Get the source code</a>
for both boinc and boinc_samples.
Put them in the same parent directory;
otherwise relative paths won't work.
<li> <a href=compile.php>Build the BOINC software</a>
(you only need the api/ and lib/ parts of it).
</ul>

The example applications are:
<ul>
<li>
<b>upper_case</b>:
a full-featured example BOINC application.
The application does things (like checkpointing and graphics)
that can be tricky or confusing.
You can use it as a template for your own BOINC application;
just rip out the computation part
(which is trivial) and replace it with your code.
<p>
The graphics show a bouncing 3D ball.
If you put files Helvetica.txf and logo.jpg in the directory
where it runs, you'll also see an image and some nice-looking text
(thanks to Tolu Aina for the latter).
<li>
<b>wrapper</b>: used to support <a href=wrapper.php>legacy applications</a>.
<li>
<b>worker</b>: a representative 'legacy' application
(i.e. it doesn't use the BOINC API or runtime library).
Used for testing wrapper.
<li>
<b>sleeper</b>: test application for non-CPU-intensive projects
(used for testing the BOINC core client).

</ul>

<p>
The boinc_samples tree includes project files for the following platforms:
<ul>
<li> <b>Windows</b>:
includes project files for Microsoft Visual Studio 2003 and 2005.
Also includes a project file samples.dev
for <a href=http://www.bloodshed.net/>Bloodshed<a>,
a free development environment for Windows
(this project file doesn't work yet).
These are in the win_build/ directory.
<li> <b>Mac OS X</b>:
includes an Xcode project file for upper_case,
mac_build/UpperCase.xcodeproj
<li> <b>Linux</b>:
includes a Makefile for building on Linux.
For upper_case, this produces a separate .so containing the graphics part.
The Makefile links some libraries statically
(stdc++, glut etc.) so that the app will run on machines
where these are old or missing.
It also uses a technique where the main program
exports its symbols to the graphics .so,
which eliminates lots of the problems we had in Einstein@home.
</ul>

<p>
";

page_tail();
?>