README.md 1.9 KB
Lynar Studios - Standard Library 2020.2.0
This is a cross-platform standard library written in C++ which provides basic functionality and implementation, like:
- Boxing Classes
- File Operations
- Minimal Reflection
- Date Class
- State Machine Class
- Serialization
- JSON
- XML
- Logger Class
It has been tested on Windows, Linux and MacOS systems.
Change Log
- isolated header files by restructuring the project
- improved Logger class by passing IWriter implementation to constructor
- improved exceptions by adding exception name to messages
- added NullPointerException
- added StandardOutputWriter class, which is an IWriter implementation
- improved CMakeLists.txt by removing unnecessary header files and also generating static, shared and module libraries now
Documentation
You can find a detailed documentation on Lynar Studios Website: lynarstudios.com
License
This software is licensed and uses MIT-license. You can find a LICENSE.MIT file inside the project's root directory.
Building
To build this library you'd need a recent version of cmake and your OS specific compiler collection, like gcc, MSVC or AppleClang installed.
Inside project's root directory create the following folder:
cmake_build_release
Open your OS specific command line window and navigate to this new folder and run the following command to configure the project and generate a native build system:
cmake ../
Inside cmake_build_release folder you will now find cmake generated files. To compile the library now, just run:
cmake --build . --config Release
Testing
This project contains unit tests to accomplish test coverage.
To run those unit tests you have to adjust TestHelper class by adding your personal test folder path to getTestFolderLocation method.
There you have to adjust location variable based on the operating system you're using.