Skip to content

Commit 1c765eb

Browse files
authored
Update README.md
1 parent 7a53c09 commit 1c765eb

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

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

44
*An small Logging library for embedded systems.*
55

6-
It's designed to expose the main features of extensive logging libraries such as log4j, log4net & CocoaLumberjack, with a small footprint.
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.
77

88
## Features
99

@@ -90,6 +90,7 @@ void verbose(const char *format, va_list logVariables);
9090

9191
where the format string can be used to format the log variables
9292

93+
```
9394
* %s display as string (char*)
9495
* %c display as single character
9596
* %d display as integer value
@@ -100,6 +101,7 @@ where the format string can be used to format the log variables
100101
* %B display as binary number, prefixed by `0b'
101102
* %t display as boolean value "t" or "f"
102103
* %T display as boolean value "true" or "false"
104+
```
103105

104106
The format string may come from flash memory.
105107

@@ -116,12 +118,12 @@ examples
116118
## Credit
117119

118120
Based on library by
119-
* https://github.com/mrRobot62
121+
* [/mrRobot62](https://github.com/mrRobot62)
120122

121123
Bugfixes & features by
122-
* https://github.com/rahuldeo2047
123-
* https://github.com/NOX73
124-
* https://github.com/dhylands
124+
* [rahuldeo2047](https://github.com/rahuldeo2047)
125+
* [NOX73](https://github.com/NOX73)
126+
* [dhylands](https://github.com/dhylands)
125127

126128

127129
## On using and modifying libraries

0 commit comments

Comments
 (0)