add readme in tools dir

2023-11-24 09:55:58 +01:00
parent 8f5a85bd4d
commit db7cbe4f1b
2 changed files with 48 additions and 0 deletions
@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2023, fanasina
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,24 @@
+# ytools_t
+
+Set of tools containing a few functions and comparison macros. We've also redefined the basic types to standardize macros that expect a type formed from a single word.
+
+## types
+```
+TYPE_CHAR == char; TYPE_U_CHAR == unsigned char; TYPE_INT == int; 
+TYPE_U_INT == unsigned int; TYPE_L_INT == long int; TYPE_U_L_INT == unsigned long int
+TYPE_SIZE_T == size_t; TYPE_FLOAT == float; TYPE_DOUBLE == double; 
+TYPE_L_DOUBLE == long double; TYPE_STRING == char*
+```
+
+## Precision
+`PRECISION_TYPE_FLOAT,  PRECISION_TYPE_DOUBLE, PRECISION_TYPE_L_DOUBLE` values can be modified on compilation with :
+```
+-D PRECISION_TYPE_FLOAT=100000000
+-D PRECISION_TYPE_DOUBLE=100000000000 
+-D PRECISION_TYPE_L_DOUBLE=100000000000000
+```
+for example, these values are the default precision for each type.
+
+Precision values for other types are 1.
+
+