switch the "namespace" to "lce"

[libcext.git] / README.md

diff --git a/README.md b/README.md
index cea3998906e487f01e6947ecfbe88ba88e5341e4..e9373ec148bad174de9ad7184505b45adbb0d39b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,26 +7,26 @@ All functions are implemented as macros expanding to an internal function refere
 Include the header in every file needed as usual:
 
 ```
 Include the header in every file needed as usual:
 
 ```

-#include "<ext-func-name>.h"
+#include "${function}.h"

 ```
 
 In the file chosen for the function implementation:
 
 ```
 ```
 
 In the file chosen for the function implementation:
 
 ```

-#define <EXT-FUNC-NAME>_IMPLEMENTATION
-#include "<ext-func-name.h>"
+#define LCE_${FUNCTION}_IMPLEMENTATION
+#include "${function}.h>"

 ```
 
 By default, the header won't have any stdlib includes, change that with:
 
 ```
 ```
 
 By default, the header won't have any stdlib includes, change that with:
 
 ```

-#define <EXT-FUNC-NAME>_INCLUDE_LIBC
+#define LCE_${FUNCTION}_INCLUDE_LIBC

 ```
 
 Or disable function, type and variable override with:
 
 ```
 ```
 
 Or disable function, type and variable override with:
 
 ```

-#define HAVE_<EXT-FUNC-NAME>
+#define HAVE_${FUNCTION}

 ```
 
 ### Specifics
 ```
 
 ### Specifics


@@ -53,9 +53,9 @@ includes `getopt()`, `getsubopt()`, `getopt_long()` and `getopt_long_only()`
 permuting, defining those enables it per function (GNU behaviour, can still be disabled at runtime by setting `$POSIXLY_CORRECT`):
 
 ```
 permuting, defining those enables it per function (GNU behaviour, can still be disabled at runtime by setting `$POSIXLY_CORRECT`):
 
 ```

-#define GETOPT_PERMUTE_ARGS
-#define GETOPT_LONG_PERMUTE_ARGS
-#define GETOPT_LONG_ONLY_PERMUTE_ARGS
+#define LCE_GETOPT_PERMUTE_ARGS
+#define LCE_GETOPT_LONG_PERMUTE_ARGS
+#define LCE_GETOPT_LONG_ONLY_PERMUTE_ARGS

 ```
 
 ---
 ```
 
 ---


@@ -65,10 +65,16 @@ permuting, defining those enables it per function (GNU behaviour, can still be d
 includes `strdup()` and `strndup()`
 
 `strndup()` follows the latest standard, meaning that it copies at most _n_ chars, not _n_ + 1.
 includes `strdup()` and `strndup()`
 
 `strndup()` follows the latest standard, meaning that it copies at most _n_ chars, not _n_ + 1.

-also, no standard specifies that `strndup()` should return less than _n_ if `strlen(s) + 1` < _n_, but this implementation does so.
+Also, no standard specifies that `strndup()` should return less than _n_ if `strlen(s) + 1` < _n_, but this implementation does so.

 
 ---
 
 ### strlcat
 
 includes `strlcat()` and `strlcpy()`
 
 ---
 
 ### strlcat
 
 includes `strlcat()` and `strlcpy()`

+
+---
+
+### strtonum
+
+includes `strtonum()`