##############################
# QuRT build instructions
#############################
#
# Scons based build system
#

Instruction for setting up Scons build system environemnt on Windows:
    - Install Python 2.5.2 or above
    - Install Scons 2.1 or above for Windows
    - Make sure <python path> and <python scripts path> are in the ENVIRONMENT
        -eg: C:\Python26 and C:\Python26\scripts

Instruction for setting up Scons build system environemnt on Unix:
    - Make sure Python 2.5.2 or above are in the path
    - Under Unix, download and unzip the .zip Scons library from the internet on your mapped Linux Disk
  	- "cd" into the downloaded scons folder
    - Run "python setup.py install --prefix=$HOME" and make sure to attach the path in the Environment PATH variable.

Instruction for installing Scons on various system:
    - http://www.scons.org/doc/HTML/scons-user/
	
Command for kernel installation
    For Usage details:
    scons --help
    
    Usage:
    scons [OPTIONS]
    
    [OPTIONS]
                --target=<TARGET>                            #Target (REQUIRED)
                --install_dir=<INSTALL DIRECTORY>            #Install Directory
                --build_dir=<BUILD_DIRECTORY>                #Build Directory  
				--q6_tools_ver=<Q6_TOOLS_VER>                #Q6 tools version
                --api_dir=<API_DIRECTORY>                    #api location
				--island_mode                                #Turn on island mode (passed to test cases)
                --extra_warnings                             #Turn on extra QuRT build warnings
                         				                     #will be overwritten if tools root (Q6_TOOLS_RTOS) is specified or Q6 tools version (--q6_tools_ver) is specified
				--test_objs                                  #Turn on extra QuRT test building
                -c                                           #Cleaning the installation
				
    set Q6_TOOLS_ROOT as optional, otherwise default tools will be used. This will be overwritten if --q6_tools_ver is specified.
	Windows: set Q6_TOOLS_ROOT=<location of the HEXAGON TOOL> e.g, Q6_TOOLS_ROOT=C:\Qualcomm\HEXAGON_Tools\5.0.14
    Linux: export Q6_TOOLS_ROOT=<location of the HEXAGON TOOL> e.g, Q6_TOOLS_ROOT=/pkg/qct/software/hexagon/releases/tools/5.0.14