diff --git a/README.md b/README.md index 7e11f2181..e78c24cbc 100644 --- a/README.md +++ b/README.md @@ -13,25 +13,24 @@ This distribution contains: 1. The OS Abstraction Layer Library 2. Tests and example applications -3. Impelemtations for the following targets: +3. for the following targets: - Generic PPC running vxWorks 6.x ( Tested on vxWorks 6.4 ) - - Axiom m5235BCC Coldfire Evaluation board running the RTEMS 4.7 Operating System - - A standard Intel Pentium PC running Linux - - The sparc/sis simulator running RTEMS -4. A directory structre and makefiles to manage it all. + - Axiom m5235BCC Coldfire Evaluation board running the RTEMS 4.10 Operating System + - A PC running Linux ( Tested on CentOS 5.x and 6.x 32 bit ) + - The sparc/sis simulator running RTEMS 4.10.2 +4. A directory structure and makefiles to manage it all. Getting Started: ================ -See the document doc/OSAL-Configuration-Guide-1.0.doc for complete details. +See the document *doc/OSAL-Configuration-Guide.doc* for complete details. An easy way to get started is to use the Linux port: ----------------------------------------------------- -1. Set the OSAL_SRC environment variable to point to the OSAL source code. - - Running setvars.sh will set the variable for you ($ . ./setvars.sh) -2. Edit the build/osal-config.mak file and set the following options: - - BSP - Set this to the board you are running on. For a PC running linux, just use *pc-linux* +1. Set the *OSAL_SRC* environment variable to point to the OSAL source code. + - Running setvars.sh will set the variable for you ($source ./setvars.sh) +2. Edit the *build/osal-config.mak* file and set the following options: + - BSP - Set this to the board you are running on. For a PC running linux, use *pc-linux* - OS - Set this to the OS you are running. For a PC running linux, use *posix*. Buiding on a PC running linux: @@ -43,15 +42,15 @@ In build/osal-config.mak: OS=posix BSP=pc-linux -Now just type *make* from the build directory and it should build the OSAL core files, tests, and sample applications for you.The binary for each application is its own directory ( i.e. build/examples/tasking-example/tasking-example.bin ) You can switch to that directory and run it. You can also debug it using GDB. +Now just type *make* from the build directory and it should build the OSAL core files, tests, and sample applications for you. The binary for each application is in its own directory (i.e. build/examples/tasking-example/tasking-example.bin) You can switch to that directory and run it. You can also debug it using GDB. -NOTE: Running on linux may require root privledges or adjusting the posix message queue maximum sizes. +NOTE: Running on linux may require root or adjusting the posix message queue maximum sizes. The Embedded targets take a little more work to run, because they must be cross compiled and booted on the board. By copying a target, you should be able to come up with a new target. If you would like just the OSAL itself, just look in src/os/inc for the include files and src/os/ for the OSAL implementation. -The API document is in the *doc* directory. +The API documentation is in the *doc* directory. Contact Information: ====================