arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-07-29 05:21:37 +03:00
Code Activity

board generator documentation (#4989)

Browse Source 
* update "more flash" doc

* doc: try to emphasize OOM knowledge

* fighting with markdown?

* it seems I can't emphasize text in link

* board generator doc: need reviewers

* markdown formatting, typos

* typos

* add links

* + last memory failure allocation + emphasis exception decoder

* more emphasis on exception decoder

* repeat the board generator introduction

* fixes
This commit is contained in:
david gauchard
2018-08-01 06:00:59 +02:00
committed by Develo
parent 7d5997dad1
commit 3ab38d690d
3 changed files with 125 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
doc/faq/readme.rst
View File

@ -43,10 +43,14 @@ entering an issue report, please perform initial troubleshooting.
How can I get some extra KBs in flash ?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Using ``*printf()`` with floats is enabled by default. Some KBs of flash can
be saved by using the option ``--nofloat`` with the boards generator:
* Using ``*printf()`` with floats is enabled by default. Some KBs of flash can
be saved by using the option ``--nofloat`` with the boards generator:
``./tools/boards.txt.py --nofloat --allgen``
``./tools/boards.txt.py --nofloat --allgen``
* Use the debug level option ``NoAssert-NDEBUG`` (in the Tools menu)
`Read more <a05-board-generator.rst>`__.
Why can't I use WPS ?
~~~~~~~~~~~~~~~~~~~~~
@ -56,6 +60,8 @@ WPS (and lose 4KB of useable ram), use this boards generator option:
``./tools/boards.txt.py --allowWPS --allgen``
`Read more <a05-board-generator.rst>`__.
This Arduino library doesn't work on ESP. How do I make it work?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -139,3 +145,17 @@ The following lines are compatible with both lwIP versions:
}
Ref. `#1923 <https://github.com/esp8266/Arduino/issues/1923>`__
Why is there a board generator and what about it ?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The board generator is a python script originally intended to ease the
Arduino IDE's `boards.txt` configuration file about the multitude of
available boards, especially when common parameters have to be updated for
all of them.
This script is also used to manage uncommon options that are currently not
available in the IDE menu.
`Read more <a05-board-generator.rst>`__.