Changeset 10318

Timestamp:

04/07/11 20:45:12 (14 years ago)

Author:

tbretz

Message:

Added some more information.

File:

• trunk/FACT++/MAINPAGE (modified) (5 diffs)

trunk/FACT++/MAINPAGE

@@ -44 +44 @@
 
 <B>Libraries:</B>
-- boost-dev (>=V1.40, all)
-- mysql++-dev
+- libreadline, libreadline-dev
+- boost, boost-dev (>=V1.40, all)
+- mysql++, mysql++-dev
+- libcfits, libcfitsio-dev
+- libccfits, libccfits-dev
 
 <B>Documentation:</B>
@@ -51 +54 @@
 - graphviz
 - [global] optional (if htags should be used in Doxyfile)
+- help2man
+- man2html
 
 <B>Only for maintainers:</B>
@@ -56 +61 @@
 - autoconf-archive
 - libtool (contains libtoolize
+- colorsvn (recommended)
+- colorgcc (recommended)
 
 @section Demo Current demonstration programs
@@ -84 +91 @@
 from test3 via Dim.
 
+@section Documentation
+
+Each program has an extensive help text (except the examples). This help text can
+be displayed with the \b --help option. For each program a man-page is automatically
+created (from the help-output), which (at the moment) can be accessed with <B>man
+FILE</B>.
+
+<!--
+
+help2man -N -o test3.man test3
+
+(man2html can do the conversion online)
+
+groff -mandoc `man -w ./test3.man` -T html > test3.html
+groff -mandoc `man -w ./test3.man` -t | ps2pdf - - > test3.pdf
+
+-->
 
 @section References
@@ -107 +131 @@
 - <A HREF="http://www.boost.org/doc/libs/1_45_0/libs/conversion/lexical_cast.htm">boost lexical_cast (V1.45.0)</A>
 
+@subsection fitsref FITS references
+- <A HREF="http://heasarc.gsfc.nasa.gov/docs/heasarc/fits.html">The FITS data format</A>
+- <A HREF="http://heasarc.gsfc.nasa.gov/fitsio/">FITS homepage</A>
+- <A HREF="http://heasarc.gsfc.nasa.gov/fitsio/CCfits/">CCfits - A C++ wrapper to cfitsio</A>
+- <A HREF="http://heasarc.gsfc.nasa.gov/docs/software/ftools/fv/">fv - A very simple viewer to FITS file contents</A>
+
 @section Available programs