Skip to content

Commit d9d84c6

Browse files
committed
Documentation fix
1 parent e63d707 commit d9d84c6

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -242,9 +242,9 @@ and understand this library.
242242

243243
__Congratulations, you have made your first project with Commander API :)__
244244

245-
**The importance of response function**
245+
# The importance of response function
246246

247-
![](https://github.com/dani007200964/Commander-API/blob/master/Doc/images/images/response_function_explained_01.png)
247+
![](https://github.com/dani007200964/Commander-API/blob/master/Doc/images/response_function_explained_01.png)
248248
Imagine a system that has a various number of channels to communicate with.
249249
For example a Linux system, which has its shell redirected to SSH, Serial, GUI...
250250
If a command arrives in one of the supported channels, you want to generate
@@ -256,12 +256,12 @@ function to it. The advanced demo shows how to add a response function correctly
256256
If you don't use a response function, please use NULL as argument. In this case the
257257
error messages will be redirected to INTERPRETER_PRINTF definition.
258258

259-
**Print the description**
259+
# Print the description
260260

261-
![](https://github.com/dani007200964/Commander-API/blob/master/Doc/images/images/description_example.png)
261+
![](https://github.com/dani007200964/Commander-API/blob/master/Doc/images/description_example.png)
262262
To print the description you just have to add a question mark to the end of the command.
263263

264-
**When and how to use a buffer?**
264+
# When and how to use a buffer?
265265

266266
Commander API designed to work mainly on embedded devices. In these devices usually you work
267267
from RAM. If you work from RAM you have an option to modify the contant of the command that
@@ -290,7 +290,7 @@ If it is too short, than you can't interpret large commands correctly.
290290

291291
If you __does not need a buffer__, than you __MUST uncomment__ INTERPRETER_BUFFER_SIZE!
292292

293-
**Arduino printf function**
293+
# Arduino printf function
294294

295295
The arduino_printf function is implemented by compatibility reasons. Commander API requires
296296
a printf like function as a communication channel. This function acts like a printf function,

0 commit comments

Comments
 (0)