Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 12beb84

Browse files
committed
[doc] Update README
1 parent cec710b commit 12beb84

File tree

1 file changed

+37
-17
lines changed

1 file changed

+37
-17
lines changed

‎README.md‎

Lines changed: 37 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,31 @@
11
# Arduino RT-Thread Library #
22

3-
This is a fork of [RT-Thread](https://github.com/RT-Thread/rt-thread) project and modified for Arduino.
3+
This project is forked from [RT-Thread](https://github.com/RT-Thread/rt-thread) (an open source RTOS) and modified for Arduino platform.
44

5-
Currently most of the optional components are removed for the sake of simplicity. Later, some of the those will be brought back.
5+
I hope this project will release the power of multitasking on Arduino platform.
6+
7+
8+
## Available Drivers ##
9+
10+
| Driver | Dependence | Remark |
11+
| --- | --- | --- |
12+
| SPI | | |
13+
| IIC | | |
14+
| SD Card | SPI | |
15+
| ILI9341 (LCD) | SPI | Tested with Adafruit 2.8" TFT Touch Shield v2 |
16+
| FT6206 (Touch Screen) | IIC | Tested with Adafruit 2.8" TFT Touch Shield v2 |
617

718

819
## Available Components ##
920

21+
| Component | Dependence | Remark |
22+
| --- | --- | --- |
23+
| FinSH | Serial | |
24+
| MSH | FinSH | |
25+
| FAT Filesystem | [ChaN's FatFs](http://elm-chan.org/fsw/ff/00index_e.html) | |
26+
| uLog | Serial | |
27+
| Dynamic Module | | Arduino App |
28+
1029
* FinSH (A tiny shell)
1130
- Support history
1231
- Support autocompletion
@@ -15,36 +34,37 @@ Currently most of the optional components are removed for the sake of simplicity
1534

1635
* MSH (Module Shell)
1736
- More in line with Unix shell's usage habits
18-
- Smaller memory footprint than FinSH
37+
- Smaller memory footprint
1938
- Support history
2039
- Support autocompletion
2140
- Support user defined commands
2241

23-
* uLog (Micro logging system)
24-
- Very useful debug tool
25-
26-
* FAT filesystem
42+
* FAT Filesystem
2743
- Support exFAT (off by default)
2844
- Support long filename (off by default)
2945
- Support non-English characters (off by default)
3046
- Support opening multiple files (4 by default)
47+
- Article: [A Better SD Library with RT-Thread](https://create.arduino.cc/projecthub/onelife/a-better-sd-library-with-rt-thread-242130)
3148

32-
* SPI SD driver
33-
- Enabled by default for MKRZero board
49+
* uLog (Micro logging system)
50+
- Very useful debug tool
51+
52+
* Dynamic Module (Dynamic Shared Library Linker)
53+
- Enabled Arduino App
54+
- Article: [Arduino App with RT-Thread](https://create.arduino.cc/projecthub/onelife/arduino-app-with-rt-thread-96438f)
3455

3556

3657
## Supported Architectures ##
37-
* SAM (ARM Cortex-M3, Tested with Arduino Due)
38-
* SAMD (ARM Cortex-M0+, Tested with Arduino MKRZero)
58+
59+
| Architecture | Core | Remark |
60+
| --- | --- | --- |
61+
| SAM | ARM Cortex-M3 | Tested with Arduino Due |
62+
| SAMD | ARM Cortex-M0+ | Tested with Arduino MKRZero |
3963

4064

4165
## License ##
4266

43-
| Module | License |
44-
| --- | --- |
67+
| Component | License |
68+
| --- | --- |
4569
| RT-Thread core | Apache License 2.0 |
4670
| FatFS | FatFs (BSD like) License |
47-
48-
49-
## Known Issues ##
50-
None

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /