# NuttX README Files

Last Updated: December 24, 2011

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
     |   |   |- avr/
     |   |   |   `- README.txt
     |   |   |- sh/
     |   |   |   |- include/
     |   |   |   |   |-m16c/README.txt
     |   |   |   |   |-sh1/README.txt
     |   |   |   |   `-README.txt
     |   |   |   |- src/
     |   |   |   |   |-common/README.txt
     |   |   |   |   |-m16c/README.txt
     |   |   |   |   |-sh1/README.txt
     |   |   |   |   `-README.txt
     |   |   |- x86/
     |   |   |   |- include/
     |   |   |   |   `-README.txt
     |   |   |   `- src/
     |   |   |       `-README.txt
     |   |   |- z80/
     |   |   |   `- src/
     |   |   |       `- z80/README.txt
     |   |   `- README.txt
     |   |- configs/
     |   |   |- amber/
     |   |   |   `- README.txt
     |   |   |- avr32dev1/
     |   |   |   `- README.txt
     |   |   |- c5471evm/
     |   |   |   |- include/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- demo9s12ne64/
     |   |   |   `- README.txt
     |   |   |- detron/
     |   |   |   `- README.txt
     |   |   |- ea3131/
     |   |   |   `- README.txt
     |   |   |- ea3152/
     |   |   |   `- README.txt
     |   |   |- eagle100/
     |   |   |   |- include/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- 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
     |   |   |- hymini-stm32v/
     |   |   |   |- include/README.txt
     |   |   |   |- RIDE/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- kwikstik-k40/
     |   |   |   `- README.txt
     |   |   |- lm3s6965-ek/
     |   |   |   |- include/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- lm3s8962-ek/
     |   |   |   |- include/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- lpcxpresso-lpc1768/
     |   |   |   `- README.txt
     |   |   |- m68332evb/
     |   |   |   |- include/README.txt
     |   |   |   `- src/README.txt
     |   |   |- mbed/
     |   |   |   `- README.txt
     |   |   |- mcu123-lpc214x/
     |   |   |   |- include/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- micropendous3/
     |   |   |   `- README.txt
     |   |   |- mx1ads/
     |   |   |   |- include/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- ne64badge/
     |   |   |   `- README.txt
     |   |   |- ntosd-dm320/
     |   |   |   |- doc/README.txt
     |   |   |   |- include/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- nucleus2g/
     |   |   |   `- README.txt
     |   |   |- olimex-lpc1766stk/
     |   |   |   `- README.txt
     |   |   |- olimex-lpc2378/
     |   |   |   |- include/README.txt
     |   |   |   `- README.txt
     |   |   |- olimex-strp711/
     |   |   |   |- include/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- pcblogic-pic32mx/
     |   |   |   `- README.txt
     |   |   |- pic32-starterkit/
     |   |   |   `- README.txt
     |   |   |- pjrc-8051/
     |   |   |   |- include/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- qemu-i486/
     |   |   |   |- include/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- rgmp/
     |   |   |   |- include/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt>
     |   |   |- sam3u-ek/
     |   |   |   `- README.txt
     |   |   |- sim/
     |   |   |   |- include/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- skp16c26/
     |   |   |   |- include/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- stm3210e-eval/
     |   |   |   |- include/README.txt
     |   |   |   |- RIDE/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- stm3240g-eval/
     |   |   |   `- README.txt
     |   |   |- sure-pic32mx/
     |   |   |   `- README.txt
     |   |   |- teensy/
     |   |   |   `- README.txt
     |   |   |- twr-k60n512/
     |   |   |   `- README.txt
     |   |   |- us7032evb1/
     |   |   |   |- bin/README.txt
     |   |   |   |- include/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- vsn/
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- xtrs/
     |   |   |   |- include/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- z16f2800100zcog/
     |   |   |   |- ostest/README.txt
     |   |   |   |- pashello/README.txt
     |   |   |   `- README.txt
     |   |   |- z80sim/
     |   |   |   |- include/README.txt
     |   |   |   |- src/README.txt
     |   |   |   `- README.txt
     |   |   |- z8encore000zco/
     |   |   |   |- ostest/README.txt
     |   |   |   `- README.txt
     |   |   |- z8f64200100kit/
     |   |   |   |- ostest/README.txt
     |   |   |   `- README.txt
     |   |   `- README.txt
     |   |- drivers/
     |   |   |- lcd/
     |   |   |   `- README.txt
     |   |   `- README.txt
     |   |- fs/
     |   |   |- mmap/
     |   |   |   `- README.txt
     |   |   `- nxffs/
     |   |       `- README.txt
     |   |- graphics/
     |   |   `- README.txt
     |   |- lib/
     |   |   `- README.txt
     |   |- libxx/
     |   |   `- README.txt
     |   |- syscall/
     |   |   `- README.txt
     |   `- tools/
     |       `- README.txt
     `- apps/
         |- README.txt
         |- examples/
         |   |- pashello/README.txt
         |   `- README.txt
         |- graphics/
         |   `- ">tiff/README.txt
         |- interpreters/
         |   |- ficl/README.txt
         |   `- README.txt
         |- netutils/
         |   |   |- ftpc/README.txt
         |   |   |- telnetd/README.txt
         |   `- README
         |- nshlib/
         |   `- README.txt
         |- system/
         |       |- i2c/README.txt
         |       |- free/README.txt
         |       `- install/README.txt
         `- vsn/
             |- hello/README.txt
             |- poweroff/README.txt
             |- ramtron/README.txt
             |- sdcard/README.txt
             |- sysinfo/README.txt
             `- README.txt