This repository represents the Lynar Studios - Standard Library (ls-std).

Patrick 74f9a45ddc Change library version 3 years ago
config 84b7be3222 Added code style file 3 years ago
include dcbdb72511 Fix include paths 3 years ago
source ea442e1466 Improve Logger class 3 years ago
test dcbdb72511 Fix include paths 3 years ago
.gitignore 2ee11bc5fb Extended .gitignore file 3 years ago
CMakeLists.txt adc35cccec Change library version 3 years ago
LICENSE.MIT bbf7536450 Rename LICENSE.txt file 3 years ago
README.md 35f90c12ca Update README.md file 3 years ago

README.md

Lynar Studios - Standard Library 2020.2.1

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

  • fixed include paths of header files

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

Add Library To Your Project

If you would like to add this library to your cmake project - to the CMakeLists.txt file - make sure that you add the libraries' include directory:

include_directories(${CMAKE_CURRENT_LIST_DIR}/path/to/this/library/include)

Then link the library binary file inside your CMakeLists.txt file:

target_link_libraries(... "path/to/this/library/../libls_std_YYYY.MAJOR.MINOR.dll")

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.