README file for WaylandCB 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 waylandcb-x.x.xx.tar.bz2

It is assumed that you have unpacked the distribution archive into
a clean directory. The included files are:
WaylandCB.hpp      // class definition
WaylandCB.cpp      // source module
gString.hpp        // class definition
gString.cpp        // source module
Wayclip.hpp        // demonstration app header
Wayclip.cpp        // demonstration app source module
Makefile           // makefile for building demonstration app 
waylandcb.info     // Texinfo (info-format) documentation
waylandcb.html     // Texinfo (HTML-format) documentation
infodoc-styles.css // CSS3 style definitions for HTML documentation
README             // this file

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

About the WaylandCB interface class:
------------------------------------
   For systems running under the Wayland communications protocol within the 
   GNOME/Wayland compositor (or other Wayland-based window manager), the 
   WaylandCB interface class provides your console applications with seamless 
   access the system clipboard. 
   -- Wayland is managed by the X.org Foundation.
   -- The GNOME/Wayland compositor is managed by The GNOME Project.

Dependency:
-----------
   a) In order for the WaylandCB interface class to connect with the 
      system (Wayland) clipboard, the "wl-clipboard" package must be 
      installed on your system. This package was written by Sergey Bugaev et al, 
      and is available on most distro mirror sites.
                  sudo dnf install 'wl-clipboard'
                    or
                  sudo apt-get install 'wl-clipboard'
      This package consists of two console utilities, "wl-copy" and 'wl-paste".

Build the demonstration application:
------------------------------------
   a) Navigate to the source directory where you unpacked the archive.
   b) To enable a debug log file, open WaylandCB.hpp with a text editor and 
      set the conditional compile flag: DEBUG_WCB (1)
      Debugging information will be written to: wcblog.txt
      [This flag should be reset for production builds: DEBUG_WCB (0)]
   c) Invoke the compiler/linker with: 'gmake' (ENTER)
      The test application, including WaylandCB and gString classes, 
      should build without errors and without warnings.
   d) Invoke the demonstration application: './wayclip --version' (ENTER)
      A copyright message should be displayed, confirming that the build 
      was successful. If not, then please check your compiler version 
      and linker paths.
   e) Test the connection between WaylandCB and the Wayland system clipboard 
      by invoking the demo app:  './wayclip'
      If the connection is successful, the application's menu will be displayed.
      If the connection fails, a warning message will be displayed and the 
      application will exit.

To read the Texinfo documentation:
   a) At the command line, type: info -f ./waylandcb.info
        or
   b) Load waylandcb.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 is not included in this archive, 
but IS included as part of the full NcDialog API source archive.

