Skip to content

Commit f2e749f

Browse files
committed
doxygen: convert 2.quick-start
Signed-off-by: Chen Wang <[email protected]>
1 parent 9ddf420 commit f2e749f

File tree

4 files changed

+12
-11
lines changed

4 files changed

+12
-11
lines changed

documentation/2.quick-start/keil-installation/keil-installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Keil MDK Installation
1+
@page quickstart_keil Keil MDK Installation
22

33
Before running the RT-Thread operating system, we need to install MDK-ARM 5.24 (either official or evaluation version, version 5.14 and above), this version is also a relatively new version. This version can provide relatively complete debugging functions. Here, we are using evaluation version 5.24 of 16k compiled code limit. If you want to remove the 16k compiled code limit, please purchase the official MDK-ARM.
44

documentation/2.quick-start/quick-start.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Start Guide: Simulate STM32F103 on Keil Simulator
1+
@page quick_start Start Guide
22

33
Because of its particularity, the embedded operating system is often closely related to the hardware platform, and specific embedded operating systems can only run on specific hardware. For those who might not have an RT-Thread compatible hardware module, or want to test out their ideas, a complete RT-Thread system can be developed in the simulation environment MDK-ARM.
44

@@ -8,11 +8,11 @@ Because of its full STM32F103 software simulation environment, the MDK-ARM integ
88

99
What will follow is a demonstration of RT-Thread running on a simulated STM32F103 microcontroller through MDK-ARM.
1010

11-
## Preparation
11+
# Preparation
1212

13-
MDK development environment: MDK-ARM 5.24 (official or evaluation version, version 5.14 and above) needs to be installed. This version is a relatively new version, which can provide relatively complete debugging functions. An installation guide can be found here: [Keil MDK Installation](./keil-installation/keil-installation.md).
13+
MDK development environment: MDK-ARM 5.24 (official or evaluation version, version 5.14 and above) needs to be installed. This version is a relatively new version, which can provide relatively complete debugging functions. An installation guide can be found here: @subpage quickstart_keil.
1414

15-
## First acquaintance with RT-Thread
15+
# First acquaintance with RT-Thread
1616

1717
To see the code size of RT-Thread we first need to get an example of RT-Thread that is suited for this environment, which can be obtained from the following link:
1818

@@ -69,7 +69,7 @@ After compiling RT-Thread/STM32, we can simulate running RT-Thread through the M
6969
![simulate RT-Thread2](./figures/6.png)
7070

7171

72-
## User Entry Code
72+
# User Entry Code
7373

7474
The above startup code is related to the RT-Thread system, so how do users add initialization code for their own applications? RT-Thread uses main function as the user code entry, all you need to do is just add your own code to the main function.
7575

@@ -83,7 +83,7 @@ int main(void)
8383
8484
>Note: In order to complete the initialization for the system functions before entering the main program, you can use the `$sub$$` and `$super$$` function identifiers to call another sample before entering the main program, this was, users can ignore the initialization operations before the main() function. See [ARM® Compiler v5.06 for µVision® armlink User Guide](http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.dui0377g/pge1362065967698.html) for details.
8585
86-
## Example of a Marquee
86+
# Example of a Marquee
8787
8888
For technical engineers working on electronics, marquee is probably the simplest example, the equivalent of Hello World in every programming language programmers learn. So we will start with a marquee in the following example, to make it periodically update (turn on or off) the LED.
8989
@@ -123,13 +123,13 @@ int led(void)
123123
MSH_CMD_EXPORT(led, RT-Thread first led sample);
124124
```
125125

126-
## Other Examples
126+
# Other Examples
127127

128128
Additional kernel examples can be found in the kernel-sample-0.1.0 directory.
129129

130130
![more kernel samples](./figures/14.png)
131131

132-
## Frequently Asked Question
132+
# Frequently Asked Question
133133

134134
* Compilation error occurred as following:
135135

documentation/Doxyfile

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -914,7 +914,8 @@ RECURSIVE = YES
914914
# run.
915915

916916
EXCLUDE = ./0.doxygen/mainpage.h \
917-
./README.md
917+
./README.md \
918+
./2.quick-start/quick_start_qemu
918919

919920
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
920921
# directories that are symbolic links (a Unix file system feature) are excluded

documentation/INDEX.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
@subpage introduction
44

5-
- [Start Guide: Simulate STM32F103 on KEIL simulator](quick-start/quick-start.md)
5+
@subpage quick_start
66

77
**Kernel**
88

0 commit comments

Comments
 (0)