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

Patrick-Christopher Mattulat 6c04f1e878 Remove unnecessary cmake variables 3 năm trước cách đây
config 84b7be3222 Added code style file 4 năm trước cách đây
include 04a7a66e31 Fix include directives 3 năm trước cách đây
source 5a7140e790 Extend EventManager class 3 năm trước cách đây
test c707e7a388 Remove unnecessary methods from listener classes 3 năm trước cách đây
.gitignore 2ee11bc5fb Extended .gitignore file 4 năm trước cách đây
CMakeLists.txt 6c04f1e878 Remove unnecessary cmake variables 3 năm trước cách đây
LICENSE.MIT bbf7536450 Rename LICENSE.txt file 4 năm trước cách đây
README.md d5b88c41d8 Increase library version 3 năm trước cách đây

README.md

Lynar Studios - Standard Library 2020.3.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
  • Event Handling

It has been tested on Windows, Linux and MacOS systems.

Changelog

  • improved CMakeLists.txt file by adding functionality to build project with or without tests

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.