Skip to content
This repository was archived by the owner on Jan 18, 2023. It is now read-only.

Commit ac168d3

Browse files
authored
Update README.md and use allman astyle
1 parent aade3aa commit ac168d3

File tree

3 files changed

+25
-13
lines changed

3 files changed

+25
-13
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Arduino IDE version: 1.8.19
3131
Arduino mbed_nano core v3.4.1
3232
Nano_33_BLE board
3333
OS: Ubuntu 20.04 LTS
34-
Linux xy-Inspiron-3593 5.15.0-52-generic #58~20.04.1-Ubuntu SMP Thu Oct 13 13:09:46 UTC 2022 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
3535
3636
Context:
3737
I encountered a crash while using this library
@@ -62,12 +62,13 @@ Please use the `astyle` to reformat the updated library code as follows (demo fo
6262
1. Change directory to the library GitHub
6363

6464
```
65-
xy@xy-Inspiron-3593:~$ cd Arduino/xy/ESPAsync_WiFiManager_GitHub/
66-
xy@xy-Inspiron-3593:~/Arduino/xy/ESPAsync_WiFiManager_GitHub$
65+
xy@xy-Inspiron-3593:~$ cd Arduino/xy/FS_Nano33BLE_GitHub/
66+
xy@xy-Inspiron-3593:~/Arduino/xy/FS_Nano33BLE_GitHub$
6767
```
6868

6969
2. Issue astyle command
7070

7171
```
72-
xy@xy-Inspiron-3593:~/Arduino/xy/ESPAsync_WiFiManager_GitHub$ bash utils/restyle.sh
72+
xy@xy-Inspiron-3593:~/Arduino/xy/FS_Nano33BLE_GitHub$ bash utils/restyle.sh
7373
```
74+

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@
66
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing)
77
[![GitHub issues](https://img.shields.io/github/issues/khoih-prog/FS_Nano33BLE.svg)](http://github.com/khoih-prog/FS_Nano33BLE/issues)
88

9-
<a href="https://www.buymeacoffee.com/khoihprog6" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 50px !important;width: 181px !important;" ></a>
9+
10+
<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="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+
<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="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>
12+
<a href="https://profile-counter.glitch.me/khoih-prog/count.svg" title="Total khoih-prog Visitor count"><img src="https://profile-counter.glitch.me/khoih-prog/count.svg" style="height: 30px;width: 200px;"></a>
13+
<a href="https://profile-counter.glitch.me/khoih-prog-FS_Nano33BLE/count.svg" title="FS_Nano33BLE Visitor count"><img src="https://profile-counter.glitch.me/khoih-prog-FS_Nano33BLE/count.svg" style="height: 30px;width: 200px;"></a>
1014

1115
---
1216
---
@@ -48,12 +52,12 @@
4852

4953
## Important Notes
5054

51-
Avoid using FATFS because the somehow (issue with the core ???) it's OK to use only with 512KB. Please use the better LittleFS, where you can select the size anywhere from 64KB to 512KB.
55+
Avoid using `FATFS` because the somehow (issue with the core ???) it's OK to use only with `512KB`. Please use the better `LittleFS`, where you can select the size anywhere from 64KB to 512KB.
5256

5357

5458
## Features
5559

56-
This library is just a simple LittleFS wrapper to facilitate your usage of LittleFS for the onboard flash on **MBED nRF52840-based boards such as Nano_33_BLE, Nano_33_BLE_Sense**, using [**Arduino-mbed mbed_nano** core](https://github.com/arduino/ArduinoCore-mbed)
60+
This library is just a simple `LittleFS` wrapper to facilitate your usage of `LittleFS` for the onboard flash on **MBED nRF52840-based boards such as Nano_33_BLE, Nano_33_BLE_Sense**, using [**Arduino-mbed mbed_nano** core](https://github.com/arduino/ArduinoCore-mbed)
5761

5862
The filesystem access uses normal [POSIX APIs](https://www.tutorialspoint.com/c_standard_library/stdio_h.htm) or [mbed FileSystem APIs](https://os.mbed.com/docs/mbed-os/v6.10/apis/file-system-apis.html)
5963

@@ -96,7 +100,7 @@ Another way to install is to:
96100

97101
1. Install [VS Code](https://code.visualstudio.com/)
98102
2. Install [PlatformIO](https://platformio.org/platformio-ide)
99-
3. Install [**FS_Nano33BLE** library](https://platformio.org/lib/show/12751/FS_Nano33BLE) by using [Library Manager](https://platformio.org/lib/show/12751/FS_Nano33BLE/installation). Search for **FS_Nano33BLE** in [Platform.io Author's Libraries](https://platformio.org/lib/search?query=author:%22Khoi%20Hoang%22)
103+
3. Install [**FS_Nano33BLE** library](https://registry.platformio.org/libraries/khoih-prog/FS_Nano33BLE) by using [Library Manager](https://registry.platformio.org/libraries/khoih-prog/FS_Nano33BLE/installation). Search for **FS_Nano33BLE** in [Platform.io Author's Libraries](https://platformio.org/lib/search?query=author:%22Khoi%20Hoang%22)
100104
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)
101105

102106

@@ -127,7 +131,7 @@ https://github.com/khoih-prog/FS_Nano33BLE/blob/141121ee1552ddf249d09c297f5d49a8
127131

128132
The following is the sample terminal output when running example [FS_Counting](examples/FS_Counting) on MBED Nano_33_BLE using **LittleFS**
129133

130-
```
134+
```cpp
131135
Start FS_Test on Nano 33 BLE
132136
LittleFS_Nano33BLE v1.2.1
133137
FS_size (KB) = 256
@@ -162,7 +166,7 @@ Times have been run = 3
162166
The following is the sample terminal output when running example [FS_Test](examples/FS_Test) on MBED Nano_33_BLE using **LittleFS**
163167
164168
165-
```
169+
```cpp
166170
Start FS_Test on Nano 33 BLE
167171
LittleFS_Nano33BLE v1.2.1
168172
FS_size (KB) = 256
@@ -220,7 +224,6 @@ Deleting file: /fs/hello2.txt => OK
220224
====================================================
221225
222226
Test complete
223-
224227
```
225228

226229
---
@@ -230,7 +233,7 @@ Test complete
230233
The following is the sample terminal output when running example [FS_Test](examples/FS_Test) on MBED Nano_33_BLE using **FATFS**
231234

232235

233-
```
236+
```cpp
234237
Start FS_Test on Nano 33 BLE
235238
FATFS_Nano33BLE v1.2.1
236239
FS_size (KB) = 512
@@ -340,6 +343,8 @@ Submit issues to: [FS_Nano33BLE issues](https://github.com/khoih-prog/FS_Nano33B
340343
6. Add support to Seeeduino nRF52840-based boards such as **SEEED_XIAO_NRF52840 and SEEED_XIAO_NRF52840_SENSE**, etc. using Seeeduino `mbed` core
341344
7. Add astyle using `allman` style. Restyle the library
342345
8. Display compile warning only when `_FS_LOGLEVEL_ > 3`
346+
9. Add astyle using `allman` style. Restyle the library
347+
343348

344349
---
345350
---
@@ -378,6 +383,6 @@ If you want to contribute to this project:
378383

379384
## Copyright
380385

381-
Copyright 2021- Khoi Hoang
386+
Copyright (c) 2021- Khoi Hoang
382387

383388

changelog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing)
77
[![GitHub issues](https://img.shields.io/github/issues/khoih-prog/FS_Nano33BLE.svg)](http://github.com/khoih-prog/FS_Nano33BLE/issues)
88

9+
10+
<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="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+
<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="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>
12+
<a href="https://profile-counter.glitch.me/khoih-prog/count.svg" title="Total khoih-prog Visitor count"><img src="https://profile-counter.glitch.me/khoih-prog/count.svg" style="height: 30px;width: 200px;"></a>
13+
<a href="https://profile-counter.glitch.me/khoih-prog-FS_Nano33BLE/count.svg" title="FS_Nano33BLE Visitor count"><img src="https://profile-counter.glitch.me/khoih-prog-FS_Nano33BLE/count.svg" style="height: 30px;width: 200px;"></a>
14+
915
---
1016
---
1117

0 commit comments

Comments
 (0)