README file for BuildCart utility. Release 0.0.01
Copyright 2023-2024 by The Software Samurai
Software released under GPL3+, and documentation released under FDL1.3+
=======================================================================

OVERVIEW
========

The Build Cartouche ('BuildCart') utility is a GNU/Linux console application 
which can be used to convert any block of text into a formatted text block 
enclosed within a border.

This application was designed under Fedora Linux and is built using the 
GNU C compiler, version 13.3.1 or higher (C++17 support required).
If you are not using GCC, then verify that your compiler fully supports 
the C++17 standard.


Download and unpack the distribution archive:
=============================================

Navigate to the base directory where package will be installed (example):
   cd ~/SoftwareDesign
Move the archive file to the base directory:
   mv ~/Dowloads/buildcart-0.0.01.tar.bz2 .
Unpack the tar archive:
   tar -xjvf buildcart-0.0.01.tar.bz2
Navigate to the target directory:
   cd BuildCart

After unpacking the archive, the directories will look something like this:

.../SoftwareDesign/BuildCart/
      BuildCart.cpp   <== Application definition and implementation
      gString.hpp     <== gString class definition (text analysis and formatting)
      gString.cpp     <== gString class implementation 
      Makefile        <== Build the 'bcart' application
      README          <== Package description, release notes (this file)

Building the application:
=========================

To build the application, type:
   gmake all
This will remove any stale object files or executable, and then will build and 
link the application to create the executable.
The application should build without errors and without warnings.

To test the build, type:
   ./bcart --version

For invocation options, type:
   ./bcart --help
or simply:
   ./bcart

For a more detailed explanation of each command-line option, please refer to 
the web-page version of this readme file at:
http://www.softwaresam.us/docs/html_doc/BuildCart_Notes.html

Make the application visible on the system $PATH.
=================================================

This can be done in either of two ways:
1) copy the executable to a directory on the path:
   cp --preserve=all ./bcart  ~/usr/local/bin/.
2) create a symbolic link to the executable in the source directory.
   cp --symbolic-link ./bcart ~/usr/local/bin/.


Notes on the current release:
=============================

This is the first public release; however, it is an extremely simple 
application, so it is hoped that the application will build and perform as 
documented. If you encounter a problem, please sent the author a note via website.
- - - - -
Please see the header of "BuildCart.cpp" for a list of all changes since the 
previous release.

Known bugs and other issues:
============================
None identified at this time.

