Skip to content

Commit 555de4e

Browse files
lbuquelbuque
committed
docs: Add usage documentation for startup ui
Signed-off-by: lbuque <[email protected]>
1 parent 2d8564d commit 555de4e

File tree

18 files changed

+346
-36
lines changed

18 files changed

+346
-36
lines changed

‎docs/_static/controllers/cardputer/applist.png

299 KB
Loading

‎docs/_static/controllers/cardputer/apprun.png

297 KB
Loading

‎docs/_static/controllers/cardputer/develop.png

299 KB
Loading

‎docs/_static/controllers/cardputer/launcher.png

295 KB
Loading

‎docs/_static/controllers/cardputer/setting.png

297 KB
Loading

‎docs/en/controllers/cardputer.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
#########
2+
Cardputer
3+
#########
4+
5+
.. include:: ../refs/controllers.cardputer.ref
6+
7+
**********
8+
Startup UI
9+
**********
10+
11+
|launcher.png|
12+
13+
**LEFT** and **RIGHT** key cycle through the available applications.
14+
15+
**Enter** launches the selected application.
16+
17+
|setting.png|
18+
19+
**LEFT** and **RIGHT** key cycle through the available applications.
20+
21+
**Enter** launches the selected application.
22+
23+
**ESC** and **BtnA** quits the application.
24+
25+
|develop.png|
26+
27+
**ESC** and **BtnA** quits the application.
28+
29+
|apprun.png|
30+
31+
**A** key runs the application once.
32+
33+
**O** key runs the application always.
34+
35+
**ESC** and **BtnA** quits the application.
36+
37+
|applist.png|
38+
39+
**UP** and **DOWN** key cycle through the available applications.
40+
41+
**A** key runs the application once.
42+
43+
**O** key runs the application always.
44+
45+
**ESC** and **BtnA** quits the application.

‎docs/en/controllers/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ Controllers
88
atoms3-lite.rst
99
atoms3u.rst
1010
stamps3.rst
11+
cardputer.rst

‎docs/en/get-started/index.rst

Lines changed: 34 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,50 @@
11
Get Started
22
============
33

4-
Currently UIFLOW2 supports the following boards：
4+
.. include:: ../refs/controllers.ref
5+
6+
Currently UIFLOW2 supports the following boards:
7+
8+
CORE
9+
----
510

611
================== ================== ==================
7-
|AtomS3|_ |AtomS3 Lite|_ |AtomS3U|_
12+
|CoreS3| |Core2| |TOUGH|
813
------------------ ------------------ ------------------
9-
`AtomS3`_ `AtomS3 Lite`_ `AtomS3U`_
14+
`CoreS3`_ `Core2`_ `TOUGH`_
15+
------------------ ------------------ ------------------
16+
|BASIC| |BASIC v2.6| |BASIC v2.7|
17+
------------------ ------------------ ------------------
18+
`BASIC`_ `BASIC v2.6`_ `BASIC v2.7`_
1019
------------------ ------------------ ------------------
11-
|StampS3|_ |CoreS3|_ |Core2|_
20+
|GRAY| |FIRE| |FIRE v2.6|
1221
------------------ ------------------ ------------------
13-
`StampS3`_ `CoreS3`_ `Core2`_
22+
`GRAY`_ `FIRE`_ `FIRE v2.6`_
1423
------------------ ------------------ ------------------
15-
|TOUGH|_
24+
|FIRE v2.7| |M5Capsule| |M5Dial|
1625
------------------ ------------------ ------------------
17-
`TOUGH`_
26+
`FIRE v2.7`_ `M5Capsule`_ `M5Dial`_
27+
------------------ ------------------ ------------------
28+
|Cardputer| |Core2 v1.1|
29+
------------------ ------------------ ------------------
30+
`Cardputer`_ `Core2 v1.1`_
1831
================== ================== ==================
1932

20-
.. |AtomS3| image:: https://static-cdn.m5stack.com/resource/docs/products/core/AtomS3/img-ee8b91d5-f96a-4605-bd05-420ecde256c4.webp
21-
.. _AtomS3: https://docs.m5stack.com/zh_CN/core/AtomS3
22-
23-
.. |AtomS3 Lite| image:: https://static-cdn.m5stack.com/resource/docs/products/core/AtomS3%20Lite/img-dc6432b6-fd9b-4066-9a4d-49786503d1a3.webp
24-
.. _AtomS3 Lite: https://docs.m5stack.com/zh_CN/core/AtomS3%20Lite
25-
26-
.. |AtomS3U| image:: https://static-cdn.m5stack.com/resource/docs/products/core/AtomS3U/img-82d5d251-1bfd-4133-9324-404242e5acc7.webp
27-
.. _AtomS3U: https://docs.m5stack.com/zh_CN/core/AtomS3U
33+
STICK
34+
-----
2835

29-
.. |StampS3| image:: https://static-cdn.m5stack.com/resource/docs/products/core/StampS3/img-964c4df6-26ff-49e0-9950-87ee1a0f3b18.webp
30-
.. _StampS3: https://docs.m5stack.com/zh_CN/core/StampS3
31-
32-
.. |CoreS3| image:: https://static-cdn.m5stack.com/resource/docs/products/core/CoreS3/img-96063e2a-637a-4d11-ac47-1ce4f1cdfd3e.webp
33-
.. _CoreS3: https://docs.m5stack.com/zh_CN/core/CoreS3
36+
================== ================== ==================
37+
|M5StickC PLUS| |M5StickC PLUS2|
38+
------------------ ------------------ ------------------
39+
`M5StickC PLUS`_ `M5StickC PLUS2`_
40+
================== ================== ==================
3441

35-
.. |Core2| image:: https://static-cdn.m5stack.com/resource/docs/products/core/core2/core2_01.webp
36-
.. _Core2: https://docs.m5stack.com/zh_CN/core/core2
3742

38-
.. |TOUGH| image:: https://static-cdn.m5stack.com/resource/docs/products/core/tough/tough_01.webp
39-
.. _TOUGH: https://docs.m5stack.com/zh_CN/core/tough
43+
ATOM
44+
----
4045

46+
================== ================== ==================
47+
|AtomS3| |AtomS3 Lite| |AtomS3U|
48+
------------------ ------------------ ------------------
49+
`AtomS3`_ `AtomS3 Lite`_ `AtomS3U`_
50+
================== ================== ==================

‎docs/en/library/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
MicroPython libraries
22
=====================
3+
4+
https://docs.micropython.org/en/v1.22.0/library/index.html

‎docs/en/refs/controllers.cardputer.ref

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. |applist.png| image:: ../../_static/controllers/cardputer/applist.png
2+
3+
.. |apprun.png| image:: ../../_static/controllers/cardputer/apprun.png
4+
5+
.. |develop.png| image:: ../../_static/controllers/cardputer/develop.png
6+
7+
.. |launcher.png| image:: ../../_static/controllers/cardputer/launcher.png
8+
9+
.. |setting.png| image:: ../../_static/controllers/cardputer/setting.png

0 commit comments

Comments
 (0)