summaryrefslogtreecommitdiffstats
path: root/doc/started/sample.t
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>1998-04-09 19:18:04 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>1998-04-09 19:18:04 +0000
commit417fcc737506f38bb8680f9e24b0a8d3e17b445c (patch)
tree96a90809eacc128be9f75eab2a2f71467a45aea4 /doc/started/sample.t
parent7ff01ac4d3eeea5ef218da032dcd7545df866e71 (diff)
downloadrtems-417fcc737506f38bb8680f9e24b0a8d3e17b445c.tar.bz2
base version
Diffstat (limited to 'doc/started/sample.t')
-rw-r--r--doc/started/sample.t56
1 files changed, 56 insertions, 0 deletions
diff --git a/doc/started/sample.t b/doc/started/sample.t
new file mode 100644
index 0000000000..ad2478d746
--- /dev/null
+++ b/doc/started/sample.t
@@ -0,0 +1,56 @@
+@c
+@c COPYRIGHT (c) 1988-1998.
+@c On-Line Applications Research Corporation (OAR).
+@c All rights reserved.
+@c
+@c $Id$
+@c
+
+@chapter Building the Sample Application
+
+@section Unpack the sample application
+
+Use the following command to unarchive the sample application:
+
+@example
+cd tools
+tar xzf ../arc/simple_app.tgz
+@end example
+
+@section Set the environment variable RTEMS_MAKEFILE_PATH
+
+It must point to the appropriate directory containing RTEMS build for our
+target and board support package combination.
+
+@example
+export RTEMS_MAKEFILE_PATH = \
+<INSTALLATION_POINT>/rtems/<BOARD_SUPPORT_PACKAGE>
+@end example
+
+Where:
+
+<INSTALLATION_POINT> and <BOARD_SUPPORT_PACKAGE> are those used in step 4.3
+
+@section Build the Sample Application
+
+Use the following command to start the build of the sample application:
+
+@example
+cd tools/simple_app
+gmake
+@end example
+
+If no errors are detected during the sample application build, it is
+reasonable to assume that the build of the GNU C/C++ Cross Compiler Tools
+for RTEMS and the build of the RTEMS OS for the selected host and target
+combination was done properly.
+
+@section Application executable
+
+If the application build has taken place without error, the application
+executable is placed in the following directory:
+
+@example
+tools/simple_app/o-<BOARD_SUPPORT_PACKAGE>/<filename>.exe
+@end example
+