NuttX README FilesLast Updated: August 30, 2019 |
Additional information can be found in the Documentation/ directory and
also in README files that are scattered throughout the source tree.
Below is a guide to the available README files.
Some README files contain more important information than others.
The key README files are shown in BOLDFACE/ITALIC below.
Below is a guide to the available README files in the NuttX source tree:
nuttx/
|- README.txt
|- arch/
| |
| |- arm/
| | `- src
| | |- common
| | | `- README_lwl_console.txt
| | |- lpc214x
| | | `- README.txt
| | `- stm32l4
| | `- stm32l4/README.txt
| |- renesas/
| | |- include/
| | | `-README.txt
| | |- src/
| | | `-README.txt
| |- x86/
| | |- include/
| | | `-README.txt
| | `- src/
| | `-README.txt
| |- z80/
| | |- src/z80
| | | `- README.txt
| | `- src/z180
| | |- README.txt
| | `- z180_mmu.txt
| `- README.txt
|- audio/
| `- README.txt
|- boards/
| |- arm/
| | |- a1x/
| | | `- pcduino-a10/
| | | `- README.txt
| | |- am335x/
| | | `- beaglebone-black/
| | | `- README.txt
| | |- c5471/
| | | `- c5471evm/
| | | `- README.txt
| | |- cxd56xx/
| | | `- spresense/
| | | `- README.txt
| | |- dm320/
| | | `- ntosd-dm320/
| | | |- doc/README.txt
| | | `- README.txt
| | |- efm32/
| | | |- efm32-g8xx-stk/
| | | | `- README.txt
| | | |- efm32gg-stk3700/
| | | | `- README.txt
| | | `- olimex-efm32g880f128-stk/
| | | `- README.txt
| | |- imx6/
| | | `- sabre-6quad/
| | | `- README.txt
| | |- imxrt/
| | | |- imxrt1050-evk/
| | | | `- README.txt
| | | `- imxrt1060-evk/
| | | `- README.txt
| | |- kinetis/
| | | |- freedom-k28f/
| | | | `- README.txt
| | | |- freedom-k64f/
| | | | `- README.txt
| | | |- freedom-k66f/
| | | | `- README.txt
| | | |- kwikstik-k40/
| | | | `- README.txt
| | | |- teensy-3.x/
| | | | `- README.txt
| | | |- twr-k60n512/
| | | | `- README.txt
| | | `- twr-k64f120m/
| | | `- README.txt
| | |- kl/
| | | |- freedom-kl25z/
| | | | `- README.txt
| | | |- freedom-kl26z/
| | | | `- README.txt
| | | `- teensy-lc/
| | | `- README.txt
| | |- lc823450/
| | | `- lc823450-xgevk/
| | | `- README.txt
| | |- lpc17xx_40xx/
| | | |- lincoln60/
| | | | `- README.txt
| | | |- lpc4088-devkit/
| | | | `- README.txt
| | | |- lpc4088-quickstart/
| | | | `- README.txt
| | | |- lpcxpresso-lpc1768/
| | | | `- README.txt
| | | |- lx_cpu/
| | | | `- README.txt
| | | |- mbed/
| | | | `- README.txt
| | | |- mcb1700/
| | | | `- README.txt
| | | |- olimex-lpc1766stk/
| | | | `- README.txt
| | | |- open1788/
| | | | `- README.txt
| | | |- pnev5180b/
| | | | `- README.txt
| | | |- u-blox-c027/
| | | | `- README.txt
| | | `- zkit-arm-1769/
| | | `- README.txt
| | |- lpc214x/
| | | |- mcu123-lpc214x/
| | | | `- README.txt
| | | `- zp214xpa/
| | | `- README.txt
| | |- lpc2378/
| | | `- olimex-lpc2378/
| | | `- README.txt
| | |- lpc31xx/
| | | |- ea3131/
| | | | `- README.txt
| | | |- ea3152/
| | | | `- README.txt
| | | `- olimex-lpc-h3131/
| | | `- README.txt
| | |- lpc43xx/
| | | |- bambino-200e/
| | | | `- README.txt
| | | |- lpc4330-xplorer/
| | | | `- README.txt
| | | |- lpc4337-ws/
| | | | `- README.txt
| | | |- lpc4357-evb/
| | | | `- README.txt
| | | `- lpc4370-link2/
| | | `- README.txt
| | |- lpc54xx/
| | | `- lpcxpresso-lpc54628/
| | | `- README.txt
| | |- max326xx/
| | | `- max32660-evsys/
| | | `- README.txt
| | |- moxart/
| | | `- moxa/
| | |- nrf52/
| | | `- nrf52-generic/
| | | `- README.txt
| | |- nuc1xx/
| | | `- nutiny-nuc120/
| | | `- README.txt
| | |- s32k1xx/
| | | |- s32k118evb/
| | | | `- README.txt
| | | |- s32k146evb/
| | | | `- README.txt
| | | `- s32k148evb/
| | | `- README.txt
| | |- sam34/
| | | |- arduino-due/
| | | | `- README.txt
| | | |- flipnclick-sam3x/
| | | | `- README.txt
| | | |- sam3u-ek/
| | | | `- README.txt
| | | |- sam4cmp-db/
| | | | `- README.txt
| | | |- sam4e-ek/
| | | | `- README.txt
| | | |- sam4l-xplained/
| | | | `- README.txt
| | | |- sam4s-xplained/
| | | | `- README.txt
| | | `- sam4s-xplained-pro/
| | | `- README.txt
| | |- sama5/
| | | |- sama5d2-xult/
| | | | `- README.txt
| | | |- sama5d3x-ek/
| | | | `- README.txt
| | | |- sama5d3-xplained/
| | | | `- README.txt
| | | `- sama5d4-ek/
| | | `- README.txt
| | |- samd2l2/
| | | |- arduino-m0/
| | | | `- README.txt
| | | |- samd20-xplained/
| | | | `- README.txt
| | | |- samd21-xplained/
| | | | `- README.txt
| | | `- saml21-xplained/
| | | `- README.txt
| | |- samd5e5/
| | | `- metro-m4/
| | | `- README.txt
| | |- samv7/
| | | |- same70-xplained/
| | | | |- README.txt
| | | `- samv71-xult/
| | | `- README.txt
| | |- stm32/
| | | |- axoloti/
| | | | `- README.txt
| | | |- clicker2-stm32/
| | | | `- README.txt
| | | |- cloudctrl/
| | | | `- README.txt
| | | |- fire-stm32v2/
| | | | `- README.txt
| | | |- hymini-stm32v/
| | | | `- README.txt
| | | |- maple/
| | | | `- README.txt
| | | |- mikroe-stm32f4/
| | | | `- README.txt
| | | |- nucleo-f103rb/
| | | | `- README.txt
| | | |- nucleo-f207zg/
| | | | `- README.txt
| | | |- nucleo-f302r8/
| | | | `- README.txt
| | | |- nucleo-f303re/
| | | | `- README.txt
| | | |- nucleo-f303ze/
| | | | `- README.txt
| | | |- nucleo-f334r8/
| | | | `- README.txt
| | | |- nucleo-f410rb/
| | | | `- README.txt
| | | |- nucleo-f446re/
| | | | `- README.txt
| | | |- nucleo-f4x1re/
| | | | `- README.txt
| | | |- nucleo-l152re/
| | | | `- README.txt
| | | |- olimexino-stm32/
| | | |- olimex-stm32-e407/
| | | | `- README.txt
| | | |- olimex-stm32-h405/
| | | | `- README.txt
| | | |- olimex-stm32-h407/
| | | | `- README.txt
| | | |- olimex-stm32-p107/
| | | |- olimex-stm32-p207/
| | | | `- README.txt
| | | |- olimex-stm32-p407/
| | | | `- README.txt
| | | |- omnibusf4/
| | | | `- README.txt
| | | |- photon/
| | | | `- README.txt
| | | |- shenzhou/
| | | | `- README.txt
| | | |- stm32_tiny/
| | | | `- README.txt
| | | |- stm3210e-eval/
| | | | `- README.txt
| | | |- stm3220g-eval/
| | | | `- README.txt
| | | |- stm3240g-eval/
| | | | `- README.txt
| | | |- stm32butterfly2/
| | | |- stm32f103-minimum/
| | | | `- README.txt
| | | |- stm32f334-disco/
| | | | `- README.txt
| | | |- stm32f3discovery/
| | | | `- README.txt
| | | |- stm32f411e-disco/
| | | | `- README.txt
| | | |- stm32f429i-disco/
| | | | |- configs/fb/README.txt
| | | | `- README.txt
| | | |- stm32f4discovery/
| | | | `- README.txt
| | | |- stm32ldiscovery/
| | | | `- README.txt
| | | |- stm32vldiscovery/
| | | | `- README.txt
| | | `- viewtool-stm32f107/
| | | `- README.txt
| | |- stm32f0l0g0/
| | | |- b-l072z-lrwan1/
| | | | `- README.txt
| | | |- nucleo-f072rb/
| | | | `- README.txt
| | | |- nucleo-f091rc/
| | | | `- README.txt
| | | |- nucleo-g070rb/
| | | | `- README.txt
| | | |- nucleo-g071rb/
| | | | `- README.txt
| | | |- nucleo-l073rz/
| | | | `- README.txt
| | | |- stm32f051-discovery/
| | | | `- README.txt
| | | `- stm32f072-discovery/
| | | `- README.txt
| | |- stm32f7/
| | | |- nucleo-144/
| | | | `- README.txt
| | | |- stm32f746g-disco/
| | | | |- configs/fb/README.txt
| | | | |- configs/nxdemo/README.txt
| | | | |- configs/nxterm/README.txt
| | | | `- README.txt
| | | |- stm32f746-ws/
| | | `- stm32f769i-disco/
| | | `- README.txt
| | |- stm32h7/
| | | `- nucleo-h743zi/
| | | `- README.txt
| | |- stm32l4/
| | | |- b-l475e-iot01a/
| | | | `- README.txt
| | | |- nucleo-l432kc/
| | | | `- README.txt
| | | |- nucleo-l452re/
| | | | `- README.txt
| | | |- nucleo-l476rg/
| | | | `- README.txt
| | | |- nucleo-l496zg/
| | | | `- README.txt
| | | |- stm32l476-mdk/
| | | | `- README.txt
| | | |- stm32l476vg-disco/
| | | | `- README.txt
| | | `- stm32l4r9ai-disco/
| | | `- README.txt
| | |- str71x/
| | | `- olimex-strp711/
| | | `- README.txt
| | |- tiva/
| | | |- dk-tm4c129x/
| | | | `- README.txt
| | | |- eagle100/
| | | | `- README.txt
| | | |- ekk-lm3s9b96/
| | | | `- README.txt
| | | |- launchxl-cc1310/
| | | | `- README.txt
| | | |- launchxl-cc1312r1/
| | | | `- README.txt
| | | |- lm3s6432-s2e/
| | | | `- README.txt
| | | |- lm3s6965-ek/
| | | | `- README.txt
| | | |- lm3s8962-ek/
| | | | `- README.txt
| | | |- lm4f120-launchpad/
| | | | `- README.txt
| | | |- tm4c123g-launchpad/
| | | | `- README.txt
| | | `- tm4c1294-launchpad/
| | | `- README.txt
| | |- tms570/
| | | |- launchxl-tms57004/
| | | | `- README.txt
| | | `- tms570ls31x-usb-kit/
| | | `- README.txt
| | `- xmc4/
| | `- xmc4500-relax/
| | `- README.txt
| |- avr/
| | |- at32uc3/
| | | `- avr32dev1/
| | | | `- README.txt
| | |- at90usb/
| | | |- micropendous3/
| | | | `- README.txt
| | | `- teensy-2.0/
| | | | `- README.txt
| | `- atmega/
| | |- amber/
| | | `- README.txt
| | |- arduino-mega2560/
| | | `- README.txt
| | `- moteino-mega/
| | `- README.txt
| |- hc/
| | `- mcs92s12ne64/
| | |- demo9s12ne64/
| | |` `- README.txt
| | `- ne64badge/
| | `- README.txt
| |- mips/
| | |- pic32mx/
| | | |- mirtoo/
| | | | `- README.txt
| | | |- pic32mx7mmb/
| | | | `- README.txt
| | | |- pic32mx-starterkit/
| | | | `- README.txt
| | | |- sure-pic32mx/
| | | | `- README.txt
| | | `- ubw32/
| | | `- README.txt
| | `-pic32mz/
| | |- flipnclick-pic32mz/
| | | `- README.txt
| | `- pic32mz-starterkit/
| | `- README.txt
| |- misoc/
| | `- lm32/
| | `- misoc/
| | `- README.txt
| |- or1k/
| | `- mor1kx/
| | `- or1k/
| | `- README.txt
| |- renesas/
| | |- m32262f8/
| | | `- skp16c26/
| | | `- README.txt
| | `-sh7032/
| | `- us7032evb1/
| | `- README.txt
| |- risc-v/
| | |- gap8/
| | | `- gapuino/
| | | `- README.txt
| | `-nr5m100/
| | `- nr5m100-nexys4/
| | `- README.txt
| |- sim/
| | `- sim/
| | `- sim/
| | `- include/README.txt
| | `- README.txt
| |- x86/
| | `- qemu/
| | `- qemu-i486/
| | `- README.txt
| |- xtensa/
| | `- esp32/
| | `- esp32-core/
| | `- README.txt
| |- z16/
| | `- z16f2811/
| | `- z16f2800100zcog/
| | |- configs/nsh/README.txt
| | |- configs/ostest/README.txt
| | |- configs/pashello/README.txt
| | `- README.txt
| |- z80/
| | |- ez80/
| | | |- ez80f910200kitg/
| | | | |- configs/ostest/README.txt
| | | | `- README.txt
| | | |- ez80f910200zco/
| | | | |- configs/dhcpd/README.txt
| | | | |- configs/httpd/README.txt/
| | | | |- configs/nettest/README.txt
| | | | |- configs/nsh/README.txt
| | | | |- configs/poll/README.txt
| | | | `- README.txt
| | | `- makerlisp/
| | | |- configs/nsh_flash/README.txt
| | | |- configs/nsh_ram/README.txt
| | | |- configs/sdboot/README.txt
| | | `- README.txt
| | |- z180/
| | | `- p112/
| | | `- README.txt
| | |- z8/
| | | |- z8encore000zco/
| | | | |- configs/ostest/README.txt
| | | | `- README.txt
| | | `- z8f64200100kit/
| | | |- configs/ostest/README.txt
| | | `- README.txt
| | `- z80/
| | `- z80sim/
| | `- README.txt
| ` README.txt
|- drivers/
| |- eeprom/
| | `- README.txt
| |- lcd/
| | |- README.txt
| | `- pcf8574_lcd_backpack_readme.txt
| |- mtd/
| | `- README.txt
| |- sensors/
| | `- README.txt
| |- syslog/
| | `- README.txt
| `- README.txt
|- fs/
| |- binfs/
| | `- README.txt
| |- cromfs/
| | `- README.txt
| |- mmap/
| | `- README.txt
| |- nxffs/
| | `- README.txt
| |- smartfs/
| | `- README.txt
| |- procfs/
| | `- README.txt
| |- spiffs/
| | `- README.md
| `- unionfs/
| `- README.txt
|- graphics/
| `- README.txt
|-libs
| |- README.txt
| |- libc/
| | |- zoneinfo/README.txt
| | `- README.txt
| |- libdsp/
| | `- README.txt
| |- libnx/
| | |- libnx/README.txt
| | `- README.txt
| |- libxx/
| | `- README.txt
|- mm/
| |- shm/
| | `- README.txt
| `- README.txt
|- net/
| |- sixlowpan/
| | `- README.txt
| `- README.txt
|- pass1/
| `- README.txt
|- syscall/
| `- README.txt
`- tools/
`- README.txt
Below is a guide to the available README files in the semi-optional apps/ source tree:
apps/
|- README.txt
|- examples/
| |- bastest/README.txt
| |- json/README.txt
| |- pashello/README.txt
| `- README.txt
|- gpsutils/
| `- "minmea/README.txt
|- graphics/
| |- "tiff/README.txt
| `- "traveler/tools/tcledit/README.txt
|- interpreters/
| |- bas/README.txt
| |- ficl/README.txt
| `- README.txt
|- modbus/
| `- README.txt
|- netutils/
| | |- discover/README.txt
| | |- ftpc/README.txt
| | |- json/README.txt
| | |- telnetd/README.txt
| `- README.txt
|- nshlib/
| `- README.txt
|- NxWidgets/
| |- Doxygen
| | `- README.txt
| |- tools
| | `- README.txt
| |- UnitTests
| | `- README.txt
| `- README.txt
|- system/
| |- cdcacm/README.txt
| |- i2c/README.txt
| |- inifile/README.txt
| |- install/README.txt
| |- nsh/README.txt
| |- nxplayer/README.txt
| |- psmq/README.txt
| |- symtab/README.txt
| |- termcurses/README.txt
| |- usbmsc/README.txt
| `- zmodem/README.txt
`- wireless
|- bluetooth
| `- btsak/README.txt
`- ieee802154
`- i8sak/README.txt
Additional README.txt files in the other, related repositories:
buildroot/ `- README.txt tools/ `- README.txt uClibc++/ `- README.txt