Commit 9b8115ad authored by thomas.forbriger's avatar thomas.forbriger Committed by thomas.forbriger
Browse files

added a short introduction

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.


SVN Path:     http://gpitrsvn.gpi.uni-karlsruhe.de/repos/TFSoftware/trunk
SVN Revision: 5099
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c
parent 523315cf
...@@ -22,6 +22,28 @@ ...@@ -22,6 +22,28 @@
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# ---- # ----
# #
# SFF++ library: reading and writing SFF from C++
# ===============================================
#
# The library is designed to provide a tool for SFF (Stuttgart File Format)
# writing and reading. It uses libgsexx for the GSE2 layer of SFF. While
# libgsexx does not explicitely use an array class for time series, libsffxx
# provides whole array reading and writing functionality. For this purpose
# the library uses code from libaff.
#
# A major advantage of the library is a feature of libgsexx. With this code
# you can deal with time series of arbitrary length. In particular no
# temporary character buffer for CM6 decoding and encoding is needed (like it
# is in the Fortran library). This means, on the other hand, that the library
# has no information to fill the nchar field of the DAST line.
#
# Warning:
# The library will write -1 to the nchar field of the DAST line. You will
# need an updated version (2.00 or higher) of libstuff or libsff (Fortran
# version) to read data files written with libsffxx to Fortran code.
#
# See the doxygen generated documentation for details.
#
# Installation instructions # Installation instructions
# ------------------------- # -------------------------
# #
...@@ -29,14 +51,13 @@ ...@@ -29,14 +51,13 @@
# #
# To instell the library together with the doxygen documentation, # To instell the library together with the doxygen documentation,
# use target all. Note that this requires doxygen to be installed. # use target all. Note that this requires doxygen to be installed.
# The doxygen documentation will be placed in $(DOXYWWWPATH).
# #
# Look at sfftest.cc for a brief example on using the code. # Look at sfftest.cc for a brief example on using the code.
# #
# The binary library libsffxx.a will be placed in $(LOCLIBDIR). The prototype # The binary library libsffxx.a will be placed in $(LOCLIBDIR). The prototype
# files will be copied to $(LOCINCLUDEDIR). # files will be copied to $(LOCINCLUDEDIR).
# #
# The doxygen documentation will be placed in $(DOXYWWWPATH).
#
# This library requires code from libgsexx, libaff, and libtime. # This library requires code from libgsexx, libaff, and libtime.
# The testprogram sfftest requires libtfxx in addition. # The testprogram sfftest requires libtfxx in addition.
# #
......
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