diff --git a/README.md b/README.md index c4e94ef6..262042dc 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# Azure RTOS GUIX +# Eclipse ThreadX GUIX -Azure RTOS GUIX is a professional-quality package, created to meet the needs of embedded systems developers. Unlike alternative GUI solutions Azure RTOS GUIX is small, fast, and easily ported to virtually any hardware configuration that’s capable of supporting graphical output. Azure RTOS GUIX also delivers exceptional visual appeal and an intuitive and powerful API for application-level user interface development. +Eclipse ThreadX GUIX is a professional-quality package, created to meet the needs of embedded systems developers. Unlike alternative GUI solutions Eclipse ThreadX GUIX is small, fast, and easily ported to virtually any hardware configuration that’s capable of supporting graphical output. Eclipse ThreadX GUIX also delivers exceptional visual appeal and an intuitive and powerful API for application-level user interface development. -Azure RTOS GUIX Studio provides a complete, embedded graphical user interface (GUI) application design environment, facilitating the creation and maintenance of all graphical elements in the application’s GUI. Azure RTOS GUIX Studio automatically generates C code that’s compatible with the Azure RTOS GUIX library, ready to be compiled and run on the target. +Eclipse ThreadX GUIX Studio provides a complete, embedded graphical user interface (GUI) application design environment, facilitating the creation and maintenance of all graphical elements in the application’s GUI. Eclipse ThreadX GUIX Studio automatically generates C code that’s compatible with the Eclipse ThreadX GUIX library, ready to be compiled and run on the target. -The Azure RTOS GUIX Studio installer is available here: https://aka.ms/azrtos-guix-installer. +The Eclipse ThreadX GUIX Studio installer is available here: https://aka.ms/azrtos-guix-installer. Here are the key features and modules of GUIX: @@ -12,11 +12,11 @@ Here are the key features and modules of GUIX: ## Getting Started -Azure RTOS GUIX as part of Azure RTOS has been integrated to the semiconductor's SDKs and development environment. You can develop using the tools of choice from [NXP](https://www.nxp.com/design/software/embedded-software/azure-rtos-for-nxp-microcontrollers:AZURE-RTOS), [Renesas](https://github.com/renesas/azure-rtos) and [Microchip](https://mu.microchip.com/get-started-simplifying-your-iot-design-with-azure-rtos). +GUIX as part of Eclipse ThreadX has been integrated to the semiconductor's SDKs and development environment. You can develop using the tools of choice from [NXP](https://www.nxp.com/design/software/embedded-software/azure-rtos-for-nxp-microcontrollers:AZURE-RTOS), [Renesas](https://github.com/renesas/azure-rtos) and [Microchip](https://mu.microchip.com/get-started-simplifying-your-iot-design-with-azure-rtos). -We also [samples](https://github.com/azure-rtos/samples) using hero development boards from semiconductors you can build and test with. +We also [samples](https://github.com/eclipse-threadx/samples) using hero development boards from semiconductors you can build and test with. -See [Overview of Azure RTOS GUIX](https://learn.microsoft.com/azure/rtos/guix/overview-guix) for the high-level overview, and all documentation and APIs can be found in: [Azure RTOS GUIX documentation](https://learn.microsoft.com/azure/rtos/guix/). +See [Overview of Eclipse ThreadX GUIX](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/guix/overview-guix.md) for the high-level overview. ## Repository Structure and Usage @@ -33,7 +33,7 @@ See [Overview of Azure RTOS GUIX](https://learn.microsoft.com/azure/rtos/guix/ov ├── LICENSE.txt # License terms ├── LICENSE-HARDWARE.txt # Licensed hardware from semiconductors ├── CONTRIBUTING.md # Contribution guidance - └── SECURITY.md # Microsoft repo security guidance + └── SECURITY.md # Repo security guidance ### Branches & Releases @@ -88,7 +88,7 @@ The master branch has the most recent code with all new features and bug fixes. ## Component dependencies -The main components of Azure RTOS are each provided in their own repository, but there are dependencies between them, as shown in the following graph. This is important to understand when setting up your builds. +The main components of Eclipse ThreadX are each provided in their own repository, but there are dependencies between them, as shown in the following graph. This is important to understand when setting up your builds. ![dependency graph](docs/deps.png) @@ -96,7 +96,7 @@ The main components of Azure RTOS are each provided in their own repository, but ### Building and using the library -Instruction for building the GUIX as static library using Arm GNU Toolchain and CMake. If you are using toolchain and IDE from semiconductor, you might follow its own instructions to use Azure RTOS components as explained in the [Getting Started](#getting-started) section. +Instruction for building the GUIX as static library using Arm GNU Toolchain and CMake. If you are using toolchain and IDE from semiconductor, you might follow its own instructions to use Eclipse ThreadX components as explained in the [Getting Started](#getting-started) section. 1. Install the following tools: @@ -104,19 +104,19 @@ Instruction for building the GUIX as static library using Arm GNU Toolchain and * [Arm GNU Toolchain for arm-none-eabi](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads) * [Ninja](https://ninja-build.org/) -1. Build the [ThreadX library](https://github.com/azure-rtos/threadx#building-and-using-the-library) as the dependency. +1. Build the [ThreadX library](https://github.com/eclipse-threadx/threadx#building-and-using-the-library) as the dependency. 1. Cloning the repo. ```bash - $ git clone https://github.com/azure-rtos/guix.git + $ git clone https://github.com/eclipse-threadx/guix.git ``` -1. Define the features and addons you need in `gx_user.h` and build together with the component source code. You can refer to [`gx_user_sample.h`](https://github.com/azure-rtos/guix/blob/master/common/inc/gx_user_sample.h) as an example. +1. Define the features and addons you need in `gx_user.h` and build together with the component source code. You can refer to [`gx_user_sample.h`](https://github.com/eclipse-threadx/guix/blob/master/common/inc/gx_user_sample.h) as an example. 1. Building as a static library - Each component of Azure RTOS comes with a composable CMake-based build system that supports many different MCUs and host systems. Integrating any of these components into your device app code is as simple as adding a git submodule and then including it in your build using the CMake `add_subdirectory()`. + Each component of Eclipse ThreadX comes with a composable CMake-based build system that supports many different MCUs and host systems. Integrating any of these components into your device app code is as simple as adding a git submodule and then including it in your build using the CMake `add_subdirectory()`. While the typical usage pattern is to include GUIX into your device code source tree to be built & linked with your code, you can compile this project as a standalone static library to confirm your build is set up correctly. @@ -128,31 +128,23 @@ Instruction for building the GUIX as static library using Arm GNU Toolchain and $ cmake --build ./build ``` -## Professional support - -[Professional support plans](https://azure.microsoft.com/support/options/) are available from Microsoft. For community support and others, see the [Resources](#resources) section below. - ## Licensing -License terms for using Azure RTOS are defined in the LICENSE.txt file of this repo. Please refer to this file for all definitive licensing information. No additional license fees are required for deploying Azure RTOS on hardware defined in the [LICENSED-HARDWARE.txt](./LICENSED-HARDWARE.txt) file. If you are using hardware not listed in the file or having licensing questions in general, please contact Microsoft directly at https://aka.ms/azrtos-license. +License terms for using Eclipse ThreadX are defined in the LICENSE.txt file of this repo. Please refer to this file for all definitive licensing information. ## Resources -The following are references to additional Azure RTOS resources: +The following are references to additional Eclipse ThreadX resources: -- **Product introduction and white papers**: https://azure.com/rtos -- **General technical questions**: https://aka.ms/QnA/azure-rtos -- **Product issues and bugs, or feature requests**: https://github.com/azure-rtos/guix/issues -- **Licensing and sales questions**: https://aka.ms/azrtos-license -- **Product roadmap and support policy**: https://aka.ms/azrtos/lts -- **Blogs and videos**: http://msiotblog.com and https://aka.ms/iotshow -- **Azure RTOS TraceX Installer**: https://aka.ms/azrtos-tracex-installer +- **Product introduction**: https://github.com/eclipse-threadx/rtos-docs +- **Product issues and bugs, or feature requests**: https://github.com/eclipse-threadx/guix/issues +- **TraceX Installer**: https://aka.ms/azrtos-tracex-installer -You can also check [previous questions](https://stackoverflow.com/questions/tagged/azure-rtos+guix) or ask new ones on StackOverflow using the `azure-rtos` and `guix` tags. +You can also check [previous questions](https://stackoverflow.com/questions/tagged/azure-rtos+guix) or ask new ones on StackOverflow using the `threadx` and `guix` tags. ## Security -Azure RTOS provides OEMs with components to secure communication and to create code and data isolation using underlying MCU/MPU hardware protection mechanisms. It is ultimately the responsibility of the device builder to ensure the device fully meets the evolving security requirements associated with its specific use case. +Eclipse ThreadX provides OEMs with components to secure communication and to create code and data isolation using underlying MCU/MPU hardware protection mechanisms. It is ultimately the responsibility of the device builder to ensure the device fully meets the evolving security requirements associated with its specific use case. ## Contribution diff --git a/docs/guix-features.png b/docs/guix-features.png index 9049a395..eb8093e3 100644 Binary files a/docs/guix-features.png and b/docs/guix-features.png differ