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
{{ message }}
This repository was archived by the owner on Jan 29, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+26-6
Original file line number
Diff line number
Diff line change
@@ -14,8 +14,8 @@ If you don't find anything, please [open a new issue](https://github.com/khoih-p
14
14
15
15
Please ensure to specify the following:
16
16
17
-
* Arduino IDE version (e.g. 1.8.16) or Platform.io version
18
-
*`Arduino mbed_rp2040` Core Version (e.g. Arduino mbed_rp2040 core v2.5.2) or `RP2040` Core Version (e.g. RP2040 core v1.9.5)
17
+
* Arduino IDE version (e.g. 1.8.19) or Platform.io version
18
+
*`Arduino mbed_rp2040` Core Version (e.g. Arduino mbed_rp2040 core v3.4.1) or `RP2040` Core Version (e.g. RP2040 core v2.6.3)
19
19
*`RP2040` Board type (e.g. Nano_RP2040_Connect, RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040, GENERIC_RP2040, etc.)
20
20
* Contextual information (e.g. what you were trying to achieve)
21
21
* Simplest possible steps to reproduce
@@ -27,14 +27,14 @@ Please ensure to specify the following:
27
27
### Example
28
28
29
29
```
30
-
Arduino IDE version: 1.8.16
31
-
Arduino mbed_rp2040 core v2.5.2
30
+
Arduino IDE version: 1.8.19
31
+
Arduino mbed_rp2040 core v3.4.1
32
32
RASPBERRY_PI_PICO board
33
33
OS: Ubuntu 20.04 LTS
34
-
Linux xy-Inspiron-3593 5.4.0-86-generic #97-Ubuntu SMP Fri Sep 17 19:19:40 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
34
+
Linux xy-Inspiron-3593 5.15.0-53-generic #59~20.04.1-Ubuntu SMP Thu Oct 20 15:10:22 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
35
35
36
36
Context:
37
-
I encountered a crash while using TimerInterrupt.
37
+
I encountered a crash while using this library
38
38
39
39
Steps to reproduce:
40
40
1. ...
@@ -43,12 +43,32 @@ Steps to reproduce:
43
43
4. ...
44
44
```
45
45
46
+
---
47
+
46
48
### Sending Feature Requests
47
49
48
50
Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.
49
51
50
52
There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/RP2040_SD/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.
51
53
54
+
---
55
+
52
56
### Sending Pull Requests
53
57
54
58
Pull Requests with changes and fixes are also welcome!
59
+
60
+
Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux)
61
+
62
+
1. Change directory to the library GitHub
63
+
64
+
```
65
+
xy@xy-Inspiron-3593:~$ cd Arduino/xy/RP2040_SD_GitHub/
<ahref="https://www.buymeacoffee.com/khoihprog6"target="_blank"><imgsrc="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png"alt="Buy Me A Coffee"style="height: 50px!important;width: 181px!important;" ></a>
9
+
10
+
<ahref="https://www.buymeacoffee.com/khoihprog6"title="Donate to my libraries using BuyMeACoffee"><imgsrc="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png"alt="Donate to my libraries using BuyMeACoffee"style="height: 50px!important;width: 181px!important;" ></a>
11
+
<ahref="https://www.buymeacoffee.com/khoihprog6"title="Donate to my libraries using BuyMeACoffee"><imgsrc="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange.svg?logo=buy-me-a-coffee&logoColor=FFDD00"style="height: 20px!important;width: 200px!important;" ></a>
@@ -98,8 +102,8 @@ But if you need to write codes to be used in both [**Arduino-mbed RP2040** core]
98
102
## Prerequisites
99
103
100
104
1.[`Arduino IDE 1.8.19+` for Arduino](https://github.com/arduino/Arduino). [](https://github.com/arduino/Arduino/releases/latest)
101
-
2.[`Arduino mbed_rp2040 core 2.7.2+`](https://github.com/arduino/ArduinoCore-mbed) for Arduino (Use Arduino Board Manager) RP2040-based boards, such as **Arduino Nano RP2040 Connect, RASPBERRY_PI_PICO, etc.**. [](https://github.com/arduino/ArduinoCore-mbed/releases/latest)
102
-
3.[`Earle Philhower's arduino-pico core v1.10.0+`](https://github.com/earlephilhower/arduino-pico) for RP2040-based boards such as **RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040 and GENERIC_RP2040**, etc. [](https://github.com/earlephilhower/arduino-pico/releases/latest)
105
+
2.[`Arduino mbed_rp2040 core 3.4.1+`](https://github.com/arduino/ArduinoCore-mbed) for Arduino (Use Arduino Board Manager) RP2040-based boards, such as **Arduino Nano RP2040 Connect, RASPBERRY_PI_PICO, etc.**. [](https://github.com/arduino/ArduinoCore-mbed/releases/latest)
106
+
3.[`Earle Philhower's arduino-pico core v2.6.3+`](https://github.com/earlephilhower/arduino-pico) for RP2040-based boards such as **RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040 and GENERIC_RP2040**, etc. [](https://github.com/earlephilhower/arduino-pico/releases/latest)
3. Install [**RP2040_SD** library](https://platformio.org/lib/show/12454/RP2040_SD) or [**RP2040_SD** library](https://platformio.org/lib/show/12454/RP2040_SD) by using [Library Manager](https://platformio.org/lib/show/12454/RP2040_SD/installation). Search for **RP2040_SD** in [Platform.io Author's Libraries](https://platformio.org/lib/search?query=author:%22Khoi%20Hoang%22)
131
+
3. Install [**RP2040_SD** library](https://registry.platformio.org/libraries/khoih-prog/RP2040_SD) by using [Library Manager](https://registry.platformio.org/libraries/khoih-prog/RP2040_SD/installation). Search for **RP2040_SD** in [Platform.io Author's Libraries](https://platformio.org/lib/search?query=author:%22Khoi%20Hoang%22)
128
132
4. Use included [platformio.ini](platformio/platformio.ini) file from examples to ensure that all dependent libraries will installed automatically. Please visit documentation for the other options and examples at [Project Configuration File](https://docs.platformio.org/page/projectconf.html)
The following is the sample terminal output when running example [CardInfo](examples/CardInfo) on MBED RaspberryPi Pico using [**Arduino-mbed RP2040** core](https://github.com/arduino/ArduinoCore-mbed)
294
298
295
-
```
299
+
```cpp
296
300
Starting SD Card CardInfo on MBED RaspberryPi Pico
297
301
MBED RP2040_SD v1.0.1
298
302
Initializing SD card with SS = 5
@@ -331,7 +335,7 @@ NEWDATA.TXT 18
331
335
332
336
The following is the sample terminal output when running example [DumpFile](examples/DumpFile) on MBED RaspberryPi Pico using [**Arduino-mbed RP2040** core](https://github.com/arduino/ArduinoCore-mbed)
333
337
334
-
```
338
+
```cpp
335
339
Starting SD Card DumpFile on MBED RaspberryPi Pico
336
340
MBED RP2040_SD v1.0.1
337
341
Initializing SD card with SS = 5
@@ -351,7 +355,7 @@ Testing RP2040 SD
351
355
352
356
The following is the sample terminal output when running example [ListFiles](examples/ListFiles) on MBED RaspberryPi Pico using [**Arduino-mbed RP2040** core](https://github.com/arduino/ArduinoCore-mbed)
353
357
354
-
```
358
+
```cpp
355
359
Starting SD Card ListFiles on MBED RaspberryPi Pico
356
360
MBED RP2040_SD v1.0.1
357
361
Initializing SD card with SS = 5
@@ -391,7 +395,7 @@ Print Directory done!
391
395
The following is the sample terminal output when running example [ReadWrite](examples/ReadWrite) on MBED RaspberryPi Pico using [**Arduino-mbed RP2040** core](https://github.com/arduino/ArduinoCore-mbed)
392
396
393
397
394
-
```
398
+
```cpp
395
399
Starting SD Card ReadWrite on MBED RaspberryPi Pico
396
400
MBED RP2040_SD v1.0.1
397
401
Initializing SD card with SS = 5
@@ -424,7 +428,7 @@ Testing writing to newtest0.txt
424
428
The following is the sample terminal output when running example [Files](examples/Files) on MBED RaspberryPi Pico using [**Arduino-mbed RP2040** core](https://github.com/arduino/ArduinoCore-mbed)
425
429
426
430
427
-
```
431
+
```cpp
428
432
Starting SD Card Files on MBED RaspberryPi Pico
429
433
MBED RP2040_SD v1.0.1
430
434
Initializing SD card with SS = 5
@@ -450,7 +454,7 @@ example.txt doesn't exist.
450
454
451
455
The following is the sample terminal output when running example [CardInfo](examples/CardInfo) on RASPBERRY_PI_PICO using [**arduino-pico core**](https://github.com/earlephilhower/arduino-pico)
452
456
453
-
```
457
+
```cpp
454
458
Starting SD Card CardInfo on RASPBERRY_PI_PICO
455
459
RP2040_SD v1.0.1
456
460
Initializing SD card with SS = 17
@@ -487,7 +491,7 @@ NEWDATA.TXT 54
487
491
The following is the sample terminal output when running example [DumpFile](examples/DumpFile) on RASPBERRY_PI_PICO using [**arduino-pico core**](https://github.com/earlephilhower/arduino-pico)
488
492
489
493
490
-
```
494
+
```cpp
491
495
Starting SD Card DumpFile on RASPBERRY_PI_PICO
492
496
RP2040_SD v1.0.1
493
497
Initializing SD card with SS = 17
@@ -507,7 +511,7 @@ Testing RP2040 SD
507
511
508
512
The following is the sample terminal output when running example [ListFiles](examples/ListFiles) on RASPBERRY_PI_PICO using [**arduino-pico core**](https://github.com/earlephilhower/arduino-pico)
509
513
510
-
```
514
+
```cpp
511
515
Starting SD Card ListFiles on RASPBERRY_PI_PICO
512
516
RP2040_SD v1.0.1
513
517
Initializing SD card with SS = 17
@@ -541,7 +545,7 @@ Print Directory done!
541
545
542
546
The following is the sample terminal output when running example [ReadWrite](examples/ReadWrite) on RASPBERRY_PI_PICO using [**arduino-pico core**](https://github.com/earlephilhower/arduino-pico)
543
547
544
-
```
548
+
```cpp
545
549
Starting SD Card ReadWrite on RASPBERRY_PI_PICO
546
550
RP2040_SD v1.0.1
547
551
Initializing SD card with SS = 17
@@ -574,7 +578,7 @@ Testing writing to newtest0.txt
574
578
575
579
The following is the sample terminal output when running example [Files](examples/Files) on RASPBERRY_PI_PICO using [**arduino-pico core**](https://github.com/earlephilhower/arduino-pico)
576
580
577
-
```
581
+
```cpp
578
582
Starting SD Card Files on RASPBERRY_PI_PICO
579
583
RP2040_SD v1.0.1
580
584
Initializing SD card with SS = 17
@@ -591,7 +595,6 @@ readData = 0xDEADBEEF
591
595
example.txt exists.
592
596
Removing example.txt...
593
597
example.txt doesn't exist.
594
-
595
598
```
596
599
597
600
---
@@ -639,6 +642,7 @@ Submit issues to: [RP2040_SD issues](https://github.com/khoih-prog/RP2040_SD/iss
639
642
1. Basic SD-wrapper library for **RP2040-based boards, such as NANO_RP2040_CONNECT, RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040 and GENERIC_RP2040**, using [**Arduino-mbed RP2040** core](https://github.com/arduino/ArduinoCore-mbed) or [**Earle Philhower's arduino-pico core**](https://github.com/earlephilhower/arduino-pico).
640
643
2. Add Version String
641
644
3. Add Table of Contents
645
+
4. Add astyle using `allman` style. Restyle the library
<ahref="https://www.buymeacoffee.com/khoihprog6"title="Donate to my libraries using BuyMeACoffee"><imgsrc="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png"alt="Donate to my libraries using BuyMeACoffee"style="height: 50px!important;width: 181px!important;" ></a>
11
+
<ahref="https://www.buymeacoffee.com/khoihprog6"title="Donate to my libraries using BuyMeACoffee"><imgsrc="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange.svg?logo=buy-me-a-coffee&logoColor=FFDD00"style="height: 20px!important;width: 200px!important;" ></a>
0 commit comments