README
^^^^^^
o Installation
o Configuring NuttX
o Building NuttX
o Documentation
INSTALLATION
^^^^^^^^^^^^
Download and Unpack:
Download and unpack the NuttX tarball. If you are reading this, then
you have probably already done that. After unpacking, you will end
up with a directory called nuttx-version (where version is the NuttX
version number). You might want to rename that directory nuttx to
match the various instructions in the documentation and some scripts
in the source tree.
That nuttx build directory should reside in a path that contains no
spaces in the higher level directory names. For example, under
Cygwin, your home directory might be formed from your first and last
names like: "/home/First Last". That will cause strange errors when
the make system tries to build.
[Actually, that problem is probably not to difficult to fix. Some
Makefiles probably just need some pathes within double quotes]
A Note about Header Files:
NuttX compiles without using the standard header files that are
distributed with your toolchain. That is correct behavior in most
cases because the header files bundled with your toolchain (such as
stdio.h) are probably not correct for use with NuttX. Certain
header files, such as setjmp.h, may be needed from your toolchain.
In that case, one solution is to copy that file from your toolchain
into the NuttX include directory. If you prefer to use the stdint.h
and stdbool.h header files from your toolchain, those could be copied
too. Using most other header files from your toolchain would probably
cause errors.
CONFIGURING NUTTX
^^^^^^^^^^^^^^^^^
"Canned" NuttX configuration files are retained in:
configs/<board-name>/<config-dir>
Where <board-name> is the name of your development board and <config-dir>.
Configuring NuttX requires only copying three files from the <config-dir>
to the directly where you installed NuttX (TOPDIR):
Copy configs/<board-name>/<config-dir>/Make.def to ${TOPDIR}/Make.defs
Make.defs describes the rules needed by you tool chain to compile
and link code. You may need to modify this file to match the
specific needs of your toolchain.
Copy configs/<board-name>/<config-dir>/setenv.sh to ${TOPDIR}/setenv.sh
setenv.sh is an optional convenience file that I use to set
the PATH variable to the toolchain binaries. You may chose to
use setenv.sh or not. If you use it, then it may need to be
modified to include the path to your toolchain binaries.
Copy configs/<board-name>/<config-dir>/defconfig to ${TOPDIR}/.config
The defconfig file holds the actual build configuration. This
file is included by all other make files to determine what is
included in the build and what is not. This file is also used
to generate a C configuration header at include/nuttx/config.h.
General information about configuring NuttX can be found in:
${TOPDIR}/configs/README.txt
${TOPDIR}/configs/<board-name>/README.txt
There is a configuration script in the tools/ directory that makes this
easier. It is used as follows:
cd ${TOPDIR}/tools
./configure.sh <board-name>/<config-dir>
BUILDING NUTTX
^^^^^^^^^^^^^^
NuttX builds in-place in the source tree. You do not need to create
any special build directories. Assuming that your Make.defs is setup
properly for your tool chain, the following steps are all that are
required to build NuttX:
cd ${TOPDIR}
make
At least one configuration (eagle100) requires additional command line
arguments on the make command. Read ${TOPDIR}/configs/<board-name>/README.txt
to see if that applies to your target.
DOCUMENTATION
^^^^^^^^^^^^^
Additional information can be found in the Documentation/ directory and
also in README files that are scattered throughout the source tree. The
documentation is in HTML and can be access by loading the following file
into your Web browser:
Documentation/index.html
NuttX documentation is also available online at http://www.nuttx.org.
Below is a guide to the available README files in the NuttX source tree:
|
|- arch/
| |
| |- arm
| | `- src
| | `- lpc214x/README.txt
| |- sh/
| | |- include/
| | | |-m16c/README.txt
| | | |-sh1/README.txt
| | | `-README.txt
| | |- src/
| | | |-common/README.txt
| | | |-m16c/README.txt
| | | |-sh1/README.txt
| | | `-README.txt
| `- z80/
| | `- src/
| | `- z80/README.txt
| `- README.txt
|- configs/
| |- c5471evm/
| | |- include/README.txt
| | |- src/README.txt
| | `- 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
| |- m68332evb/
| | |- include/README.txt
| | `- src/README.txt
| |- mcu123-lpc214x/
| | |- include/README.txt
| | |- src/README.txt
| | `- README.txt
| |- mx1ads/
| | |- include/README.txt
| | |- src/README.txt
| | `- README.txt
| |- ntosd-dm320/
| | |- doc/README.txt
| | |- include/README.txt
| | |- src/README.txt
| | `- README.txt
| |- olimex-strp711/
| | |- include/README.txt
| | |- src/README.txt
| | `- README.txt
| |- pjrc-8051/
| | |- include/README.txt
| | |- src/README.txt
| | `- 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
| |- us7032evb1/
| | |- bin/README.txt
| | |- include/README.txt
| | |- 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/
| `- README.txt
|- examples/
| |- nsh/README.txt
| |- pashello/README.txt
| `- README.txt
|- graphics/
| `- README.txt
|- libxx/
| `- README.txt
`- netutils/
|- telnetd/README.txt
`- README
78a9df89c0