Skip to content

Commit b190d87

Browse files
committed
docs: Add Add copyright information of third-party libraries
Signed-off-by: lbuque <[email protected]>
1 parent 26bd161 commit b190d87

File tree

3 files changed

+73
-1
lines changed

3 files changed

+73
-1
lines changed

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# uiflow_micropython
22

33
## How to build
4+
45
### Setting up ESP-IDF and the build environment
6+
57
```shell
68
mkdir uiflow_workspace && cd uiflow_workspace
79
git clone https://github.com/m5stack/esp-idf.git
@@ -12,11 +14,57 @@ git -C esp-idf submodule update --init --recursive
1214
```
1315

1416
### Building the firmware
17+
1518
```shell
1619
git clone https://github.com/m5stack/uiflow_micropython
1720
cd uiflow_micropython/m5stack
1821
make submodules # Only need once
1922
make littlefs
2023
make mpy-cross
24+
# atoms3, atoms3-lite
2125
make BOARD=M5STACK_S3_8MB BOARD_TYPE=atoms3 flash # Build and flash to atoms3 baord
26+
# stamps3
27+
make BOARD=M5STACK_S3_8MB BOARD_TYPE=stamps3 flash
28+
# cores3
29+
make BOARD=M5STACK_S3_SPIRAM_16MB BOARD_TYPE=cores3 flash
30+
# atoms3u
31+
make BOARD=M5STACK_S3_8MB BOARD_TYPE=atoms3u flash
32+
# core2,tough
33+
make BOARD=M5STACK_SPIRAM_16MB BOARD_TYPE=core2 flash
34+
# stickcplus2
35+
make BOARD=M5STACK_SPIRAM_8MB BOARD_TYPE=stickcplus2 flash
36+
# stickcplus
37+
make BOARD=M5STACK_4MB BOARD_TYPE=stickcplus flash
2238
```
39+
40+
## License
41+
42+
- [micropython][] Copyright (c) 2013-2023 Damien P. George and licensed under MIT License.
43+
- [umqtt][] Copyright (c) 2013-2014 micropython-lib contributors and licensed under MIT License.
44+
- [urequests][] Copyright (c) 2013-2014 micropython-lib contributors and licensed under MIT License.
45+
- [ir][] Copyright (c) 2020 Peter Hinch and licensed under MIT License.
46+
- [neopixel][] Copyright (c) 2013-2014 micropython-lib contributors and licensed under MIT License.
47+
- [bh1750fvi][] Copyright (c) 2022 Sebastian Wicki and licensed under MIT License.
48+
- [bmp280][] Copyright (c) 2020 Sebastian Wicki and licensed under MIT License.
49+
- [checksum][] Copyright (c) 2022 Sebastian Wicki and licensed under MIT License.
50+
- [dht12][] Copyright (c) 2020 Sebastian Wicki and licensed under MIT License.
51+
- [pcf8563][] Copyright (c) 2020 Sebastian Wicki and licensed under MIT License.
52+
- [qmp6988][] Copyright (c) 2022 Sebastian Wicki and licensed under MIT License.
53+
- [scd40][] Copyright (c) 2022 Sebastian Wicki and licensed under MIT License.
54+
- [sgp30][] Copyright (c) 2022 Sebastian Wicki and licensed under MIT License.
55+
- [sht4x][] Copyright (c) 2021 ladyada for Adafruit and licensed under MIT License.
56+
57+
[micropython]: https://github.com/micropython/micropython
58+
[umqtt]: https://github.com/micropython/micropython-lib
59+
[urequests]: https://github.com/micropython/micropython-lib
60+
[ir]: https://github.com/peterhinch/micropython_ir
61+
[neopixel]: https://github.com/micropython/micropython-lib
62+
[bh1750fvi]: https://github.com/gandro/micropython-m5stamp-c3u
63+
[bmp280]: https://github.com/gandro/micropython-m5stickc-plus
64+
[checksum]: https://github.com/gandro/micropython-m5stamp-c3u
65+
[dht12]: https://github.com/gandro/micropython-m5stickc-plus
66+
[pcf8563]: https://github.com/gandro/micropython-m5stickc-plus
67+
[qmp6988]: https://github.com/gandro/micropython-m5stamp-c3u
68+
[scd40]: https://github.com/gandro/micropython-m5stamp-c3u
69+
[sgp30]: https://github.com/gandro/micropython-m5stamp-c3u
70+
[sht4x]: https://github.com/adafruit/Adafruit_CircuitPython_SHT4x

docs/zh_CN/COPYRIGHT.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,18 @@ Third Party
1515

1616
* `micropython`_ Copyright (c) 2013-2023 Damien P. George and licensed under MIT License.
1717
* `umqtt`_ Copyright (c) 2013-2014 micropython-lib contributors and licensed under MIT License.
18+
* `urequests`_ Copyright (c) 2013-2014 micropython-lib contributors and licensed under MIT License.
19+
* `ir`_ Copyright (c) 2020 Peter Hinch and licensed under MIT License.
20+
* `neopixel`_ Copyright (c) 2013-2014 micropython-lib contributors and licensed under MIT License.
21+
* `bh1750fvi`_ Copyright (c) 2022 Sebastian Wicki and licensed under MIT License.
22+
* `bmp280`_ Copyright (c) 2020 Sebastian Wicki and licensed under MIT License.
23+
* `checksum`_ Copyright (c) 2022 Sebastian Wicki and licensed under MIT License.
24+
* `dht12`_ Copyright (c) 2020 Sebastian Wicki and licensed under MIT License.
25+
* `pcf8563`_ Copyright (c) 2020 Sebastian Wicki and licensed under MIT License.
26+
* `qmp6988`_ Copyright (c) 2022 Sebastian Wicki and licensed under MIT License.
27+
* `scd40`_ Copyright (c) 2022 Sebastian Wicki and licensed under MIT License.
28+
* `sgp30`_ Copyright (c) 2022 Sebastian Wicki and licensed under MIT License.
29+
* `sht4x`_ Copyright (c) 2021 ladyada for Adafruit and licensed under MIT License.
1830

1931
Documentation
2032
==============

docs/zh_CN/refs/COPYRIGHT.ref

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,14 @@
11
.. _micropython: https://github.com/micropython/micropython
2-
.. _umqtt: https://github.com/micropython/micropython-lib
2+
.. _umqtt: https://github.com/micropython/micropython-lib
3+
.. _urequests: https://github.com/micropython/micropython-lib
4+
.. _ir: https://github.com/peterhinch/micropython_ir
5+
.. _neopixel: https://github.com/micropython/micropython-lib
6+
.. _bh1750fvi: https://github.com/gandro/micropython-m5stamp-c3u
7+
.. _bmp280: https://github.com/gandro/micropython-m5stickc-plus
8+
.. _checksum: https://github.com/gandro/micropython-m5stamp-c3u
9+
.. _dht12: https://github.com/gandro/micropython-m5stickc-plus
10+
.. _pcf8563: https://github.com/gandro/micropython-m5stickc-plus
11+
.. _qmp6988: https://github.com/gandro/micropython-m5stamp-c3u
12+
.. _scd40: https://github.com/gandro/micropython-m5stamp-c3u
13+
.. _sgp30: https://github.com/gandro/micropython-m5stamp-c3u
14+
.. _sht4x: https://github.com/adafruit/Adafruit_CircuitPython_SHT4x

0 commit comments

Comments
 (0)