|
|
@@ -1,27 +1,29 @@
|
|
|
-# Lynar Studios - Standard Library 2020.1.0.0 #
|
|
|
+# Lynar Studios - Standard Library 2020.1.0 #
|
|
|
|
|
|
-This is a cross-platform standard library written in C++ and provides basic functionality and implementation, like:
|
|
|
+This is a cross-platform standard library written in C++ which provides basic functionality and implementation, like:
|
|
|
|
|
|
-- Boxing
|
|
|
+- Boxing Classes
|
|
|
- File Operations
|
|
|
-- Basic Reflection
|
|
|
-- Date
|
|
|
-- State Machine
|
|
|
+- Minimal Reflection
|
|
|
+- Date Class
|
|
|
+- State Machine Class
|
|
|
- Serialization
|
|
|
- JSON
|
|
|
- XML
|
|
|
-- Logging
|
|
|
+- Logger Class
|
|
|
|
|
|
-### Testing ###
|
|
|
+It has been tested on __Windows__, __Linux__ and __MacOS__ systems.
|
|
|
+
|
|
|
+### Documentation ###
|
|
|
|
|
|
-This project contains unit tests to provide test coverage.
|
|
|
-To run those unit tests you have to adjust __TestHelper__ class by adding your personal test folder path to __getTestFolderLocation__ method.
|
|
|
+You can find a detailed documentation on Lynar Studios Website: lynarstudios.com
|
|
|
|
|
|
+### License ###
|
|
|
|
|
|
-### Naming Convention ###
|
|
|
+This software is licensed and uses MIT-license. You can find a __LICENSE.MIT__ file inside the project's root directory.
|
|
|
|
|
|
-This library tries to stick to the following naming convention:
|
|
|
+### Testing ###
|
|
|
|
|
|
-- __parameters__ start with an underscore followed by a small letter.
|
|
|
-- __private methods__ start with an underscore followed by a small letter.
|
|
|
-- __class names__ start with an upper case letter and do then follow camel case convention.
|
|
|
+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.
|
