Skip to content

Commit 3365e3e

Browse files
authored
Update README.md
1 parent ce038f8 commit 3365e3e

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ ArduinoLog - C++ Log library for Arduino devices
33

44
*An minimalistic Logging framework for Arduino-compatible embedded systems.*
55

6-
ArduinoLog is a minimalistic framework to help the programmer output log statements to a variety of output targets, fashioned after xtensive logging libraries such as log4cpp ,log4j and log4net. In case of problems with an application, it is helpful to enable logging so that the problem can be located. ArduinoLog is designed so that log statements can remain in the code with minimal performance cost. In order to facilitate this the loglevel can be adjusted, and if the code is completely tested all logging code can be compiled out.
6+
ArduinoLog is a minimalistic framework to help the programmer output log statements to an output of choice, fashioned after extensive logging libraries such as log4cpp ,log4j and log4net. In case of problems with an application, it is helpful to enable logging so that the problem can be located. ArduinoLog is designed so that log statements can remain in the code with minimal performance cost. In order to facilitate this the loglevel can be adjusted, and (if your code is completely tested) all logging code can be compiled out.
77

88
## Features
99

@@ -118,6 +118,13 @@ examples
118118
Log.verbose (F("Log as Verbose with bool value from Flash : %t, %T"CR) , true, false );
119119
```
120120

121+
### Disable library
122+
123+
(if your code is completely tested) all logging code can be compiled out. Do this by uncommenting
124+
```c++
125+
#define DISABLE_LOGGING
126+
```
127+
in `Logging.h`. This may significantly reduce your project size.
121128

122129
## Credit
123130

0 commit comments

Comments
 (0)