NuttX README FilesLast Updated: March 25, 2016 |
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 | | `- 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/ | |- amber/ | | `- README.txt | |- arduino-mega2560/ | | `- README.txt | |- arduino-due/ | | `- README.txt | |- avr32dev1/ | | `- README.txt | |- c5471evm/ | | `- README.txt | |- cc3200-launchpad/ | | `- README.txt | |- cloudctrl/ | | `- README.txt | |- compal_e86/ | | `- README.txt | |- compal_e88/ | | `- README.txt | |- compal_e99/ | | `- README.txt | |- demo9s12ne64/ | | `- README.txt | |- dk-tm4c129x/ | | `- README.txt | |- ea3131/ | | `- README.txt | |- ea3152/ | | `- README.txt | |- eagle100/ | | `- README.txt | |- efm32-g8xx-stk/ | | `- README.txt | |- efm32gg-stk3700/ | | `- 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 | |- freedom-kl26z/ | | `- README.txt | |- hymini-stm32v/ | | |- RIDE/README.txt | | `- README.txt | |- kwikstik-k40/ | | `- README.txt | |- launchxl-tms57004/ | | `- README.txt | |- lincoln60/ | | `- README.txt | |- lm3s6432-s2e/ | | `- README.txt | |- lm3s6965-ek/ | | `- README.txt | |- lm3s8962-ek/ | | `- README.txt | |- lpc4330-xplorer/ | | `- README.txt | |- lpc4337-ws/ | | `- README.txt | |- lpc4357-evb/ | | `- README.txt | |- lpc4370-link2/ | | `- README.txt | |- lpcxpresso-lpc1115/ | | `- 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 | |- mt-db-x3// | | `- README.txt | |- moteino-mega/ | | `- README.txt | |- mx1ads/ | | `- README.txt | |- ne64badge/ | | `- README.txt | |- ntosd-dm320/ | | |- doc/README.txt | | `- README.txt | |- nucleo-f4x1re/ | | `- README.txt | |- nucleus2g/ | | `- README.txt | |- nutiny-nuc120/ | | `- README.txt | |- olimex-efm32g880f129-stk/ | | `- README.txt | |- olimex-lpc1766stk/ | | `- README.txt | |- olimex-lpc2378/ | | `- README.txt | |- olimex-lpc-h3131/ | | `- README.txt | |- olimex-stm32-h405/ | | `- README.txt | |- olimex-stm32-h407/ | | `- 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 | |- pic32mx-starterkit/ | | `- README.txt | |- pic32mx7mmb/ | | `- README.txt | |- pic32mz-starterkit/ | | `- README.txt | |- pirelli_dpl10/ | | `- README.txt | |- qemu-i486/ | | `- README.txt | |- rgmp/ | | `- README.txt | |- sabre-6quad/ | | `- README.txt | |- sama5d2-xult/ | | `- README.txt | |- sama5d3x-ek/ | | `- README.txt | |- sama5d3-xplained/ | | `- README.txt | |- sama5d4-ek/ | | `- README.txt | |- samd20-xplained/ | | `- README.txt | |- samd21-xplained/ | | `- README.txt | |- saml21-xplained/ | | `- README.txt | |- sam3u-ek/ | | `- README.txt | |- sam4e-ek/ | | `- README.txt | |- sam4l-xplained/ | | `- README.txt | |- sam4s-xplained/ | | `- README.txt | |- sam4s-xplained-pro/ | | `- README.txt | |- same70-xplained/ | | `- README.txt | |- samv71-xult/ | | `- README.txt | |- shenzhou/ | | `- README.txt | |- sim/ | | |- include/README.txt | | `- 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 | |- stm32f3discovery/ | | `- README.txt | |- stm32f4discovery/ | | `- README.txt | |- stm32f429i-disco/ | | |- ltdc/README.txt | | `- README.txt | |- stm32f746g-disco/ | | `- README.txt | |- stm32l476vg-disco/ | | `- README.txt | |- stm32ldiscovery/ | | `- README.txt | |- stm32vldiscovery/ | | `- README.txt | |- sure-pic32mx/ | | `- README.txt | |- teensy-2.0/ | | `- README.txt | |- teensy-3.1/ | | `- README.txt | |- teensy-lc/ | | `- README.txt | |- tm4c123g-launchpad/ | | `- README.txt | |- tm4c1294-launchpad/ | | `- README.txt | |- twr-k60n512/ | | `- README.txt | |- "u-blox-c027/ | | `- README.txt | |- ubw32/ | | `- README.txt | |- us7032evb1/ | | `- README.txt | |- viewtool-stm32f107/ | | `- 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/ | |- eeprom/ | | `- README.txt | |- lcd/ | | `- README.txt | |- mtd/ | | `- README.txt | |- sensors/ | | `- 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 | `- unionfs/ | `- README.txt |- graphics/ | `- README.txt |- lib/ | `- README.txt |- libc/ | `- README.txt |- libnx/ | `- README.txt |- libxx/ | `- README.txt |- mm/ | |- shm/ | | `- README.txt | `- README.txt |- net/ | `- 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 |- 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/ | `- README.txt `- system/ |- cdcacm/README.txt |- i2c/README.txt |- inifile/README.txt |- install/README.txt |- nxplayer/README.txt |- symtab/README.txt |- usbmsc/README.txt |- zmodem/README.txt `- zoneinfo/README.txt
Additional README.txt files in the other, related repositories:
NxWidgets |- Doxygen | `- README.txt |- tools | `- README.txt |- UnitTests | `- README.txt `- README.txt buildroot/ `- README.txt tools/ `- README.txt uClibc++/ `- README.txt pascal/ `- README