From ac168d3003a8564ea0eb7a2e1ca7f4005f6f0f8f Mon Sep 17 00:00:00 2001
From: Khoi Hoang <57012152+khoih-prog@users.noreply.github.com>
Date: Thu, 24 Nov 2022 21:18:51 -0500
Subject: [PATCH] Update `README.md` and use `allman` astyle
---
CONTRIBUTING.md | 9 +++++----
README.md | 23 ++++++++++++++---------
changelog.md | 6 ++++++
3 files changed, 25 insertions(+), 13 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c693cce..a154793 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -31,7 +31,7 @@ Arduino IDE version: 1.8.19
Arduino mbed_nano core v3.4.1
Nano_33_BLE board
OS: Ubuntu 20.04 LTS
-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
+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
Context:
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
1. Change directory to the library GitHub
```
-xy@xy-Inspiron-3593:~$ cd Arduino/xy/ESPAsync_WiFiManager_GitHub/
-xy@xy-Inspiron-3593:~/Arduino/xy/ESPAsync_WiFiManager_GitHub$
+xy@xy-Inspiron-3593:~$ cd Arduino/xy/FS_Nano33BLE_GitHub/
+xy@xy-Inspiron-3593:~/Arduino/xy/FS_Nano33BLE_GitHub$
```
2. Issue astyle command
```
-xy@xy-Inspiron-3593:~/Arduino/xy/ESPAsync_WiFiManager_GitHub$ bash utils/restyle.sh
+xy@xy-Inspiron-3593:~/Arduino/xy/FS_Nano33BLE_GitHub$ bash utils/restyle.sh
```
+
diff --git a/README.md b/README.md
index 5d59072..4c6ae6b 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,11 @@
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing)
[![GitHub issues](https://img.shields.io/github/issues/khoih-prog/FS_Nano33BLE.svg)](http://github.com/khoih-prog/FS_Nano33BLE/issues)
-
+
+
+
+
+
---
---
@@ -48,12 +52,12 @@
## Important Notes
-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.
+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.
## Features
-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)
+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)
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)
@@ -96,7 +100,7 @@ Another way to install is to:
1. Install [VS Code](https://code.visualstudio.com/)
2. Install [PlatformIO](https://platformio.org/platformio-ide)
-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)
+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)
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)
@@ -127,7 +131,7 @@ https://github.com/khoih-prog/FS_Nano33BLE/blob/141121ee1552ddf249d09c297f5d49a8
The following is the sample terminal output when running example [FS_Counting](examples/FS_Counting) on MBED Nano_33_BLE using **LittleFS**
-```
+```cpp
Start FS_Test on Nano 33 BLE
LittleFS_Nano33BLE v1.2.1
FS_size (KB) = 256
@@ -162,7 +166,7 @@ Times have been run = 3
The following is the sample terminal output when running example [FS_Test](examples/FS_Test) on MBED Nano_33_BLE using **LittleFS**
-```
+```cpp
Start FS_Test on Nano 33 BLE
LittleFS_Nano33BLE v1.2.1
FS_size (KB) = 256
@@ -220,7 +224,6 @@ Deleting file: /fs/hello2.txt => OK
====================================================
Test complete
-
```
---
@@ -230,7 +233,7 @@ Test complete
The following is the sample terminal output when running example [FS_Test](examples/FS_Test) on MBED Nano_33_BLE using **FATFS**
-```
+```cpp
Start FS_Test on Nano 33 BLE
FATFS_Nano33BLE v1.2.1
FS_size (KB) = 512
@@ -340,6 +343,8 @@ Submit issues to: [FS_Nano33BLE issues](https://github.com/khoih-prog/FS_Nano33B
6. Add support to Seeeduino nRF52840-based boards such as **SEEED_XIAO_NRF52840 and SEEED_XIAO_NRF52840_SENSE**, etc. using Seeeduino `mbed` core
7. Add astyle using `allman` style. Restyle the library
8. Display compile warning only when `_FS_LOGLEVEL_ > 3`
+9. Add astyle using `allman` style. Restyle the library
+
---
---
@@ -378,6 +383,6 @@ If you want to contribute to this project:
## Copyright
-Copyright 2021- Khoi Hoang
+Copyright (c) 2021- Khoi Hoang
diff --git a/changelog.md b/changelog.md
index 9a39053..3716538 100644
--- a/changelog.md
+++ b/changelog.md
@@ -6,6 +6,12 @@
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing)
[![GitHub issues](https://img.shields.io/github/issues/khoih-prog/FS_Nano33BLE.svg)](http://github.com/khoih-prog/FS_Nano33BLE/issues)
+
+
+
+
+
+
---
---