diff --git a/doc/substitutions.inc b/doc/substitutions.inc index 51de9fd5..ecd74800 100644 --- a/doc/substitutions.inc +++ b/doc/substitutions.inc @@ -1,3 +1,3 @@ .. |HARDWARE_URL| replace:: `XK-VOICE-L71 `__ .. |SOFTWARE_URL| replace:: `XCORE-VOICE `__ -.. |TOOLS_VERSION| replace:: 15.2.1 +.. |TOOLS_VERSION| replace:: 15.3.0 diff --git a/examples/asrc_demo/README.rst b/examples/asrc_demo/README.rst index 0562be13..b15ca735 100644 --- a/examples/asrc_demo/README.rst +++ b/examples/asrc_demo/README.rst @@ -69,16 +69,7 @@ Download the main repo and submodules using: Building the app ================ -First install and source the XTC version: 15.2.1 tools. The output should be -something like this: - -:: - - $ xcc --version - xcc: Build 19-198606c, Oct-25-2022 - XTC version: 15.2.1 - Copyright (C) XMOS Limited 2008-2021. All Rights Reserved. - +First make sure that your XTC tools environment is activated. Linux or Mac ------------ diff --git a/examples/ffd/README.rst b/examples/ffd/README.rst index 2899985e..9d5fe4c4 100644 --- a/examples/ffd/README.rst +++ b/examples/ffd/README.rst @@ -48,16 +48,7 @@ Supported Hardware and pre-requisites This example is supported on the XK_VOICE_L71 board. -On the host machine the XTC tools, version 15.2.1, must be installed and sourced. -The output should be -something like this: - -:: - - $ xcc --version - xcc: Build 19-198606c, Oct-25-2022 - XTC version: 15.2.1 - Copyright (C) XMOS Limited 2008-2021. All Rights Reserved. +Make sure that your XTC tools environment is activated. It is recommended to use `Ninja` or `xmake` as the make system under Windows. `Ninja` has been observed to be faster than `xmake`, however `xmake` comes natively with XTC tools. diff --git a/examples/ffva/README.rst b/examples/ffva/README.rst index dd429055..7d661da8 100644 --- a/examples/ffva/README.rst +++ b/examples/ffva/README.rst @@ -9,16 +9,7 @@ Supported Hardware and pre-requisites This example is supported on the XK_VOICE_L71 board. -On the host machine the XTC tools, version 15.2.1, must be installed and sourced. -The output should be -something like this: - -:: - - $ xcc --version - xcc: Build 19-198606c, Oct-25-2022 - XTC version: 15.2.1 - Copyright (C) XMOS Limited 2008-2021. All Rights Reserved. +Make sure that your XTC tools environment is activated. It is recommended to use `Ninja` or `xmake` as the make system under Windows. `Ninja` has been observed to be faster than `xmake`, however `xmake` comes natively with XTC tools. diff --git a/examples/low_power_ffd/README.rst b/examples/low_power_ffd/README.rst index a116c586..b73bf4c5 100644 --- a/examples/low_power_ffd/README.rst +++ b/examples/low_power_ffd/README.rst @@ -46,16 +46,7 @@ Supported Hardware and pre-requisites This example is supported on the XK_VOICE_L71 board. -On the host machine the XTC tools, version 15.2.1, must be installed and sourced. -The output should be -something like this: - -:: - - $ xcc --version - xcc: Build 19-198606c, Oct-25-2022 - XTC version: 15.2.1 - Copyright (C) XMOS Limited 2008-2021. All Rights Reserved. +Make sure that your XTC tools environment is activated. It is recommended to use `Ninja` or `xmake` as the make system under Windows. `Ninja` has been observed to be faster than `xmake`, however `xmake` comes natively with XTC tools. diff --git a/examples/mic_aggregator/README.rst b/examples/mic_aggregator/README.rst index bb480390..ca905bb4 100644 --- a/examples/mic_aggregator/README.rst +++ b/examples/mic_aggregator/README.rst @@ -2,6 +2,9 @@ PDM Microphone Aggregator Example ################################# +.. warning:: + This example is deprecated and will be moved into a separate + Application Note and may be removed in the next major release. This example provides a bridge between 16 PDM microphones to either TDM16 slave or USB Audio and targets the xcore-ai explorer board. @@ -29,16 +32,7 @@ Download the main repo and submodules using: Building the app ================ -First install and source the XTC version: 15.2.1 tools. The easiest way to source -the tools is to open the provided shortcut to ``XTC Tools 15.2.1 Command Prompt``. -Running the compiler binary ``xcc`` will produce an output like this: - -:: - - xcc --version - xcc: Build 19-198606c, Oct-25-2022 - XTC version: 15.2.1 - Copyright (C) XMOS Limited 2008-2021. All Rights Reserved. +First make sure that your XTC tools environment is activated. Linux or Mac ------------ diff --git a/examples/speech_recognition/README.rst b/examples/speech_recognition/README.rst index ffaf2c62..f2836b1f 100644 --- a/examples/speech_recognition/README.rst +++ b/examples/speech_recognition/README.rst @@ -9,16 +9,7 @@ Supported Hardware and pre-requisites This example is supported on the XK_VOICE_L71 board. However, the XCORE-AI-EXPLORER board can be supported with a couple minor modifications. -On the host machine the XTC tools, version 15.2.1, must be installed and sourced. -The output should be -something like this: - -:: - - $ xcc --version - xcc: Build 19-198606c, Oct-25-2022 - XTC version: 15.2.1 - Copyright (C) XMOS Limited 2008-2021. All Rights Reserved. +Make sure that your XTC tools environment is activated. It is recommended to use `Ninja` or `xmake` as the make system under Windows. `Ninja` has been observed to be faster than `xmake`, however `xmake` comes natively with XTC tools.