********************************************************************************
***  This file is part of Pecunia.                                           ***
***                                                                          ***
***  Copyright (C) 2017, 2018, 2019, 2020, 2021, 2023                        ***
***  John Schneiderman <Licencing _AT_ Schneiderman _DOT_ me>                ***
***                                                                          ***
***  This program is free software: you can redistribute it and/or modify it ***
***  under the terms of the GNU Lesser General Public License License as     ***
***  published by the Free Software Foundation, either version 3 of the      ***
***  License, or (at your option) any later version.                         ***
***                                                                          ***
***  This program is distributed in the hope that it will be useful, but     ***
***  WITHOUT ANY WARRANTY; without even the implied warranty of              ***
***  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                    ***
***  See the GNU Lesser General Public License License for more details.     ***
***                                                                          ***
***  You should have received a copy of the GNU Lesser General Public License***
***  along with this program. If not, see <http://www.gnu.org/licenses/>.    ***
********************************************************************************

Needed for compiling
====================
0) C++ Compiler
	- Version: Any supporting ISO C++14
	- Source: Any, http://gcc.gnu.org/

1) CMake
	- Version: 3.13+
	- Source: http://www.cmake.org

2) Qt (Optional)
	- Only needed when developing unit tests for the library.
	- Version: 5.11+
	- Source: http://www.qt.io/

3) Conan (Optional)
	- Mercurial on the path.

Build Options
=============
0) Optionally to enable the unit tests, set the CMake option Pecunia_ENABLE_TESTS to ON.

How-To compile the program
==========================
0) Run the CMake configuration tool.
1) Run the compiler of choice build command.
2) Run the compiler of choice install command.

Known Issues
============
0) Stream insertion operator does not clean up afterwards.
1) Stream extraction operator does not clean up afterwards.
2) Stream Insertion does not work correctly on Windows.
