Commit 51dd9f2e authored by thomas.forbriger's avatar thomas.forbriger
Browse files

[WP][DOC] (ticket10): adjust COPYING and README of libtsioxx

This is a legacy commit from before 2015-03-01.
It may be incomplete as well as inconsistent.
See COPYING.legacy and README.history for details.

adjusted basic documentation of new library

still missing:
- description of purpose of library and provided interfaces
parent 2773cea4
this is <COPYING> this is <COPYING>
============================================================================ ============================================================================
libtfxx C++ software library libsioxx C++ time series file input/ouput
---------------------------- -----------------------------------------
$Id: COPYING 4960 2013-02-01 09:02:16Z tforb $ $Id: COPYING 4960 2013-02-01 09:02:16Z tforb $
============================================================================ ============================================================================
The source code in this directory is part of libtfxx which The source code in this directory is part of libtfxx which
compiles libtfxx.a compiles libtfxx.a
Copyright (C) 2002, 2013 by Thomas Forbriger Copyright (C) 2005, 2007, 2013, 2014 by Thomas Forbriger
---- ----
libtfxx is free software; you can redistribute it and/or modify libtsioxx is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or the Free Software Foundation; either version 2 of the License, or
(at your option) any later version. (at your option) any later version.
This program is distributed in the hope that it will be useful, libtsioxx is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details. GNU General Public License for more details.
......
this is <README> this is <README>
============================================================================ ============================================================================
C++ library libtfxx libsioxx C++ time series file input/ouput
------------------- -----------------------------------------
$Id$ $Id$
============================================================================ ============================================================================
For compilation instructions see README.1st in the root directory of the tar-ball or
http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/docs/installation
A collection of miscellaneous code frequently used by C++ programs in
TFSoftware.
This library contains smaller and independent sets of classes and modules.
They should provide stable and reliable interfaces and sematics.
Some of them will be copied from libclass which was more for experimenting purposes.
The modules provide handling of commandline options and arguments, I/O byte swapping,
I/O for Fortran binary files, error handling, and more.
The home of this software suite is The home of this software suite is
http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/trunk/src/libs/libtfxx http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/trunk/src/libs/libtsioxx
For compilation instructions see README.1st in the root directory of the
tar-ball or
http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/docs/installation
Please send bug reports and suggestions to Please send bug reports and suggestions to
Thomas.Forbriger@kit.edu Thomas.Forbriger@kit.edu
...@@ -44,35 +36,16 @@ Dependencies: ...@@ -44,35 +36,16 @@ Dependencies:
doxygen (required to process source code documentation) doxygen (required to process source code documentation)
TFSoftware libraries required to compile the code: TFSoftware libraries required to compile the code:
direct dependencies: ? direct dependencies:
libtsxx, libaff, libsffxx, libtime, libgsexx ? libtsxx, libaff, libsffxx, libtime, libgsexx
indirect dependencies: ? indirect dependencies:
libseife, libdatrwxx ? libseife, libdatrwxx
Further non-standard libraries required to compile the code: Further non-standard libraries required to compile the code:
- the C++ standard template library (STL) - the C++ standard template library (STL)
- libboost
- libgsl
Tests and examples are provided in subdirectory tests Tests and examples are provided in subdirectory tests
The source code itself depends only on common system libraries and the STL.
A note on header files:
----------------------
We extensively comment class declarations within the header files. The
reduce compilation time when using the library code, comments will be
stripped from the header files that are exportet. These stripped versions
are placed in the source code path with name *.h.strip and will be linked to
INCINSTALLPATH with name *.h.
Although comment stripping could be done by perl with an elaborate regular
expression, we prefer the remcmmnt command by Jari Laaksonen. You can find
the code at
http://www.eti.pg.gda.pl/KATEDRY/kecs/lab-cpp/snippets/
If it is not available to you, you should set TF_REMCMMNT=cat in the Makefile.
Detailed documentation is provided through doxygen source code. See target Detailed documentation is provided through doxygen source code. See target
doxydoc in the Makefile. doxydoc in the Makefile.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment