You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+70-70Lines changed: 70 additions & 70 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,107 +6,107 @@ Azure RTOS GUIX Studio provides a complete, embedded graphical user interface (G
6
6
7
7
The Azure RTOS GUIX Studio installer is available here: https://aka.ms/azrtos-guix-installer.
8
8
9
-
## Documentation
9
+
Here are the key features and modules of GUIX:
10
10
11
-
Documentation for this library can be found here: http://docs.microsoft.com/azure/rtos/guix
11
+
12
12
13
-
#Understanding inter-component dependencies
13
+
## Getting Started
14
14
15
-
The main components of Azure RTOS are each provided in their own repository, but there are dependencies between them--shown in the following graph--that are important to understand when setting up your builds.
15
+
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).
16
16
17
-
17
+
We also [samples](https://github.com/azure-rtos/samples) using hero development boards from semiconductors you can build and test with.
18
18
19
+
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/).
19
20
20
-
#Building and using the library
21
+
## Repository Structure and Usage
21
22
22
-
##Prerequisites
23
+
### Directory layout
23
24
24
-
Install the following tools:
25
+
.
26
+
├── cmake # CMakeList files for building the project
27
+
├── common # Core GUIX files
28
+
├── fonts # Fonts required by GUIX
29
+
├── graphics # Graphic assets
30
+
├── ports # Architecture and compiler specific files
31
+
├── samples # Sample codes
32
+
├── tutorials # More sample codes
33
+
├── LICENSE.txt # License terms
34
+
├── LICENSE-HARDWARE.txt # Licensed hardware from semiconductors
35
+
├── CONTRIBUTING.md # Contribution guidance
36
+
└── SECURITY.md # Microsoft repo security guidance
25
37
26
-
*[CMake](https://cmake.org/download/) version 3.0 or later
27
-
*[GCC compilers for arm-none-eabi](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads)
28
-
*[Ninja](https://ninja-build.org/)
38
+
### Branches & Releases
29
39
30
-
## Cloning the repo
40
+
The master branch has the most recent code with all new features and bug fixes. It does not represent the latest General Availability (GA) release of the library. Each official release (preview or GA) will be tagged to mark the commit and push it into the Github releases tab, e.g. `v6.2-rel`.
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.
37
45
38
-
Each component of Azure RTOS comes with a composible 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 command `add_subdirectory()`.
46
+
39
47
40
-
While the typical usage pattern is to include threadx 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.
48
+
> You will have to take the dependency graph above into account when building anything other than ThreadX itself.
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.
47
53
48
-
NOTE: You will have to take the dependency graph above into account when building anything other than threadx itself.
54
+
1. Install the following tools:
49
55
50
-
# Repository Structure and Usage
56
+
*[CMake](https://cmake.org/download/) version 3.0 or later
57
+
*[Arm GNU Toolchain for arm-none-eabi](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads)
58
+
*[Ninja](https://ninja-build.org/)
51
59
52
-
## Branches & Releases
60
+
1. Build the [ThreadX library](https://github.com/azure-rtos/threadx#building-and-using-the-library) as the dependency.
53
61
54
-
The master branch has the most recent code with all new features and bug fixes. It does not represent the latest General Availability (GA) release of the library.
Each official release (preview or GA) will be tagged to mark the commit and push it into the Github releases tab, e.g. `v6.0-rel`.
68
+
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.
59
69
60
-
## Directory layout
70
+
1. Building as a static library
61
71
62
-
```
63
-
- cmake
64
-
- common
65
-
- inc
66
-
- src
67
-
- ports
68
-
- cortex_m0/gnu
69
-
- inc
70
-
- src
71
-
- cortex_m3/gnu
72
-
- inc
73
-
- src
74
-
- cortex_m4/gnu
75
-
- inc
76
-
- src
77
-
- cortex_m7/gnu
78
-
- inc
79
-
- src
80
-
- samples
81
-
```
72
+
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()`.
82
73
83
-
# Security
74
+
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.
84
75
85
-
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.
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 file. If you are using hardware not defined in the LICENSED-HARDWARE.txt file or have licensing questions in general, please contact Microsoft directly at https://aka.ms/azrtos-license.
86
+
[Professional support plans](https://azure.microsoft.com/support/options/) are available from Microsoft. For community support and others, see the [Resources](#resources) section below.
90
87
91
-
#Contribution, feedback, issues, and professional support
88
+
## Licensing
92
89
93
-
If you encounter any bugs, have suggestions for new features, or if you would like to become an active contributor to this project, please follow the instructions provided in the contribution guideline for the corresponding repo.
90
+
License terms forusing Azure RTOS are definedin the LICENSE.txt file of this repo. Please refer to this file forall definitive licensing information. No additional license fees are required for deploying Azure RTOS on hardware definedin the [LICENSED-HARDWARE.txt](./LICENSED-HARDWARE.txt) file. If you are using hardware not listed inthe file or having licensing questions in general, please contact Microsoft directly at https://aka.ms/azrtos-license.
94
91
95
-
For basic support, click Issues in the command bar or post a question to [Stack Overflow](http://stackoverflow.com/questions/tagged/azure-rtos+threadx) using the `threadx` and `azure-rtos` tags.
92
+
## Resources
96
93
97
-
Professional support plans (https://azure.microsoft.com/en-us/support/options/) are available from Microsoft.
94
+
The following are references to additional Azure RTOS resources:
95
+
96
+
- **Product introduction and white papers**: https://azure.com/rtos
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.
105
+
106
+
## Security
107
+
108
+
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.
98
109
99
-
#Additional Resources
110
+
## Contribution
100
111
101
-
The following are references to additional Azure RTOS and Azure IoT in general:
0 commit comments