# README Files

# NuttX README Files

Last Updated: June 27, 2014

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.

     .
     | - nuttx
     |   |- README.txt
     |   |- arch/
     |   |   |
     |   |   |- arm
     |   |   |   `- src
     |   |   |       `- lpc214x/README.txt
     |   |   |- sh/
     |   |   |   |- 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
     |   |- binfmt/
     |   |   |- libpcode/
     |   |   `- README.txt
     |   |- audio/
     |   |   `- README.txt
     |   |- configs/
     |   |   |- 16z/
     |   |   |   `- README.txt
     |   |   |- amber/
     |   |   |   `- README.txt
     |   |   |- arduino-due/
     |   |   |   `- README.txt
     |   |   |- avr32dev1/
     |   |   |   `- README.txt
     |   |   |- c5471evm/
     |   |   |   `- README.txt
     |   |   |- cloudctrl/
     |   |   |   `- README.txt
     |   |   |- compal_e86/
     |   |   |   `- README.txt
     |   |   |- compal_e88/
     |   |   |   `- README.txt
     |   |   |- compal_e99/
     |   |   |   `- README.txt
     |   |   |- demo9s12ne64/
     |   |   |   `- README.txt
     |   |   |- ea3131/
     |   |   |   `- README.txt
     |   |   |- ea3152/
     |   |   |   `- README.txt
     |   |   |- eagle100/
     |   |   |   `- README.txt
     |   |   |- ekk-lm3s9b96/
     |   |   |   `- README.txt
     |   |   |- ez80f910200kitg/
     |   |   |   |- ostest/README.txt
     |   |   |   `- README.txt
     |   |   |- ez80f910200zco/
     |   |   |   |- dhcpd/README.txt
     |   |   |   |- httpd/README.txt
     |   |   |   |- nettest/README.txt
     |   |   |   |- nsh/README.txt
     |   |   |   |- ostest/README.txt
     |   |   |   |- poll/README.txt
     |   |   |   `- README.txt
     |   |   |- fire-stm32v2/
     |   |   |   `- README.txt
     |   |   |- freedom-kl25z/
     |   |   |   `- README.txt
     |   |   |- hymini-stm32v/
     |   |   |   |- RIDE/README.txt
     |   |   |   `- README.txt
     |   |   |- kwikstik-k40/
     |   |   |   `- README.txt
     |   |   |- lincoln60/
     |   |   |   `- README.txt
     |   |   |- lm3s6432-s2e/
     |   |   |   `- README.txt
     |   |   |- lm3s6965-ek/
     |   |   |   `- README.txt
     |   |   |- lm3s8962-ek/
     |   |   |   `- README.txt
     |   |   |- lpc4330-xplorer/
     |   |   |   `- README.txt
     |   |   |- lpcxpresso-lpc1768/
     |   |   |   `- README.txt
     |   |   |- maple/
     |   |   |   `- README.txt
     |   |   |- mbed/
     |   |   |   `- README.txt
     |   |   |- mcu123-lpc214x/
     |   |   |   `- README.txt
     |   |   |- micropendous3/
     |   |   |   `- README.txt
     |   |   |- mikroe-stm32f4/
     |   |   |   `- README.txt
     |   |   |- mirtoo/
     |   |   |   `- README.txt
     |   |   |- mx1ads/
     |   |   |   `- README.txt
     |   |   |- ne64badge/
     |   |   |   `- README.txt
     |   |   |- ntosd-dm320/
     |   |   |   |- doc/README.txt
     |   |   |   `- README.txt
     |   |   |- nucleo-f401re/
     |   |   |   `- README.txt
     |   |   |- nucleus2g/
     |   |   |   `- README.txt
     |   |   |- nutiny-nuc120/
     |   |   |   `- README.txt
     |   |   |- olimex-lpc1766stk/
     |   |   |   `- README.txt
     |   |   |- olimex-lpc2378/
     |   |   |   `- README.txt
     |   |   |- olimex-lpc-h3131/
     |   |   |   `- README.txt
     |   |   |- olimex-stm32-h405/
     |   |   |   `- README.txt
     |   |   |- olimex-stm32-p107/
     |   |   |   `- README.txt
     |   |   |- olimex-stm32-p207/
     |   |   |   `- README.txt
     |   |   |- olimex-strp711/
     |   |   |   `- README.txt
     |   |   |- open1788/
     |   |   |   `- README.txt
     |   |   |- p112/
     |   |   |   `- README.txt
     |   |   |- pcblogic-pic32mx/
     |   |   |   `- README.txt
     |   |   |- pcduino-a10/
     |   |   |   `- README.txt
     |   |   |- pic32-starterkit/
     |   |   |   `- README.txt
     |   |   |- pic32mx7mmb/
     |   |   |   `- README.txt
     |   |   |- pirelli_dpl10/
     |   |   |   `- README.txt
     |   |   |- pjrc-8051/
     |   |   |   `- README.txt
     |   |   |- qemu-i486/
     |   |   |   `- README.txt
     |   |   |- rgmp/
     |   |   |   `- README.txt
     |   |   |- sama5d3x-ek/
     |   |   |   `- README.txt
     |   |   |- sama5d3-xplained/
     |   |   |   `- README.txt
     |   |   |- sama5d4-ek/
     |   |   |   `- README.txt
     |   |   |- samd20-xplained/
     |   |   |   `- README.txt
     |   |   |- sam3u-ek/
     |   |   |   `- README.txt
     |   |   |- sam4e-ek/
     |   |   |   `- README.txt
     |   |   |- sam4l-xplained/
     |   |   |   `- README.txt
     |   |   |- sam4s-xplained/
     |   |   |   `- README.txt
     |   |   |- sam4s-xplained-pro/
     |   |   |   `- README.txt
     |   |   |- shenzhou/
     |   |   |   `- README.txt
     |   |   |- sim/
     |   |   |   `- README.txt
     |   |   |- skp16c26/
     |   |   |   `- README.txt
     |   |   |- spark/
     |   |   |   `- README.txt
     |   |   |- stm3210e-eval/
     |   |   |   |- RIDE/README.txt
     |   |   |   `- README.txt
     |   |   |- stm3220g-eval/
     |   |   |   `- README.txt
     |   |   |- stm3240g-eval/
     |   |   |   `- README.txt
     |   |   |- stm32_tiny/
     |   |   |   `- README.txt
     |   |   |- stm32f100rc_generic/
     |   |   |   `- README.txt
     |   |   |- stm32f3discovery/
     |   |   |   `- README.txt
     |   |   |- stm32f4discovery/
     |   |   |   `- README.txt
     |   |   |- stm32f429i-disco/
     |   |   |   `- README.txt
     |   |   |- stm32vldiscovery/
     |   |   |   `- README.txt
     |   |   |- sure-pic32mx/
     |   |   |   `- README.txt
     |   |   |- teensy/
     |   |   |   `- README.txt
     |   |   |- tm4c123g-launchpad/
     |   |   |   `- README.txt
     |   |   |- twr-k60n512/
     |   |   |   `- README.txt
     |   |   |- ubw32/
     |   |   |   `- README.txt
     |   |   |- us7032evb1/
     |   |   |   `- README.txt
     |   |   |- viewtool-stm32f107/
     |   |   |   `- README.txt
     |   |   |- vsn/
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- xtrs/
     |   |   |   `- README.txt
     |   |   |- z16f2800100zcog/
     |   |   |   |- ostest/README.txt
     |   |   |   |- pashello/README.txt
     |   |   |   `- README.txt
     |   |   |- z80sim/
     |   |   |   `- README.txt
     |   |   |- z8encore000zco/
     |   |   |   |- ostest/README.txt
     |   |   |   `- README.txt
     |   |   |- z8f64200100kit/
     |   |   |   |- ostest/README.txt
     |   |   |   `- README.txt
     |   |   |- zkit-arm-1769/
     |   |   |   `- README.txt
     |   |   |- zp214xpa/
     |   |   |   `- README.txt
     |   |   `- README.txt
     |   |- drivers/
     |   |   |- lcd/
     |   |   |   `- README.txt
     |   |   |- mtd/
     |   |   |   `- README.txt
     |   |   |- sercomm/
     |   |   |   `- README.txt
     |   |   |- syslog/
     |   |   |   `- README.txt
     |   |   `- README.txt
     |   |- fs/
     |   |   |- binfs/
     |   |   |   `- README.txt
     |   |   |- mmap/
     |   |   |   `- README.txt
     |   |   |- nxffs/
     |   |   |   `- README.txt
     |   |   |- smartfs/
     |   |   |   `- README.txt
     |   |   `- procfs/
     |   |       `- README.txt
     |   |- graphics/
     |   |   `- README.txt
     |   |- lib/
     |   |   `- README.txt
     |   |- libc/
     |   |   `- README.txt
     |   |- libnx/
     |   |   `- README.txt
     |   |- libxx/
     |   |   `- README.txt
     |   |- mm/
     |   |   `- README.txt
     |   |- net/
     |   |   `- README.txt
     |   |- syscall/
     |   |   `- README.txt
     |   `- tools/
     |       `- README.txt
     |- apps/
     |   |- README.txt
     |   |- examples/
     |   |   |- json/README.txt
     |   |   |- pashello/README.txt
     |   |   `- README.txt
     |   |- graphics/
     |   |   `- "tiff/README.txt
     |   |- interpreters/
     |   |   |- 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/
     |   |   `- README.txt
     |   `- system/
     |       |- cdcacm/README.txt
     |       |- i2c/README.txt
     |       |- inifile/README.txt
     |       |- install/README.txt
     |       |- nxplayer/README.txt
     |       |- usbmsc/README.txt
     |       `- zmodem/README.txt
     `- NxWidgets
         |- Doxygen
         |   `- README.txt
         |- tools
         |   `- README.txt
         |- UnitTests
         |   `- README.txt
         `- README.txt