README file for gString source code archive.
Copyright 2011-2025 by The Software Samurai
Software released under GPL3+, and documentation released under FDL1.3+
=======================================================================

Unpack this archive using:  tar -xjvf gstring-x.x.xx.tar.bz2

It is assumed that you have unpacked the distribution archive into
a clean directory. The included files are:
gString.hpp        // source header (class definition)
gString.cpp        // source module (class implementation)
Makefile           // makefile for gString build
gs_test.cpp        // test application ONLY for testing the build
gsmeter.cpp        // test application for regression testing
report.pl          // Perl script for scanning conditional-compile directives
gstring.info       // Texinfo (info-formatted) documentation
gstring.html       // Texinfo (HTML-formatted) documentation
infodoc-styles.css // CSS3 style definitions for HTML documentation
README             // this file

The gString change log is located at the top of the gString.cpp source module.

Build the basic test application, 'gs_test':
   a) Navigate to the source directory where you unpacked the archive.
   b) Invoke the compiler/linker:
         'gmake' (ENTER)
      The gString library and the test application should build without errors 
      and without warnings.
   c) Run the test application: './gs_test' (ENTER)
      The gString version number and some test data should be displayed.
      If not, then please check your compiler version and linker paths.

Build the regression-test application, 'gsmeter':
   a) Navigate to the source directory where you unpacked the archive.
   b) Edit gString.hpp and set preprocessor declaration for debugging 
      to a non-zero value which enables the debugging code:
         #define DEBUG_GSTRING (1)
   c) Invoke the compiler/linker:
         "gmake gsmeter"
   d) Run the test application and follow the menu prompt:
         ./gsmeter
   e) Reset the preprocessor directive:
         #define DEBUG_GSTRING (0)

To read the Texinfo documentation:
   a) At the command line, type: info -f gstring.info
   b) Load gstring.html into your favorite browser. (Note that the CSS
      definition file "infodoc-styles.css" must be in the same directory).

To install (integrate) the documentation into the 'info' system, please see 
documentation for the Texinfo 'info' reader.

Note that the Texinfo documentation source for the gString class  
is not included in this archive, but IS included as part of the 
full NcDialog API source archive.

Known Issues:
=============
None at this time; however, v:0.0.37 was a major release, so if problems 
arise, please drop the author a note via website.