Browse Source

Extended readme file

- added information about naming conventions
- added information regarding cross-platform
pcmattulat 3 years ago
parent
commit
7dd9965513
1 changed files with 10 additions and 2 deletions
  1. 10 2
      README.md

+ 10 - 2
README.md

@@ -1,8 +1,16 @@
-# Lynar Studios - Standard Library 2020.1.0.0
+# Lynar Studios - Standard Library 2020.1.0.0 #
 
-This standard library provides basic functionality and implementation, like:
+This is a cross-platform standard library written in C++ and provides basic functionality and implementation, like:
  
 - Boxing
 - File
 - Reflection
 - Date
+
+### Naming Convention ###
+
+This library tries to stick to the following naming convention:
+
+- __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.