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

Commit b446630

Browse files
authored
Update README.md and use allman astyle
1 parent c1f5b28 commit b446630

27 files changed

+871
-619
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ If you don't find anything, please [open a new issue](https://github.com/khoih-p
1515
Please ensure to specify the following:
1616

1717
* Arduino IDE version (e.g. 1.8.19) or Platform.io version
18-
* Board Core Version (e.g. STM32F7 Nucleo-144 NUCLEO_F767ZI, STM32 core v2.2.0, etc.)
18+
* Board Core Version (e.g. STM32F7 Nucleo-144 NUCLEO_F767ZI, STM32 core v2.3.0, etc.)
1919
* Contextual information (e.g. what you were trying to achieve)
2020
* Simplest possible steps to reproduce
2121
* Anything that might be relevant in your opinion, such as:
@@ -27,26 +27,45 @@ Please ensure to specify the following:
2727

2828
```
2929
Arduino IDE version: 1.8.19
30-
STM32F7 Nucleo-144 NUCLEO_F767ZI, STM32 core v2.2.0
30+
STM32F7 Nucleo-144 NUCLEO_F767ZI, STM32 core v2.3.0
3131
OS: Ubuntu 20.04 LTS
32-
Linux xy-Inspiron-3593 5.13.0-40-generic #45~20.04.1-Ubuntu SMP Mon Apr 4 09:38:31 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
32+
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
3333
3434
Context:
35-
I encountered a crash while trying to use the Timer Interrupt.
35+
I encountered a crash while using this library
3636
3737
Steps to reproduce:
3838
1. ...
3939
2. ...
4040
3. ...
4141
4. ...
4242
```
43+
44+
---
45+
4346
### Sending Feature Requests
4447

4548
Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.
4649

4750
There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/EthernetWebServer_STM32/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.
4851

52+
---
53+
4954
### Sending Pull Requests
5055

5156
Pull Requests with changes and fixes are also welcome!
5257

58+
Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux)
59+
60+
1. Change directory to the library GitHub
61+
62+
```
63+
xy@xy-Inspiron-3593:~$ cd Arduino/xy/EthernetWebServer_STM32_GitHub/
64+
xy@xy-Inspiron-3593:~/Arduino/xy/EthernetWebServer_STM32_GitHub$
65+
```
66+
67+
2. Issue astyle command
68+
69+
```
70+
xy@xy-Inspiron-3593:~/Arduino/xy/EthernetWebServer_STM32_GitHub$ bash utils/restyle.sh
71+
```

README.md

Lines changed: 44 additions & 42 deletions
Large diffs are not rendered by default.

changelog.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
1-
## EthernetWebServer_STM32
1+
## EthernetWebServer_STM32 Library
22

33
[![arduino-library-badge](https://www.ardu-badge.com/badge/EthernetWebServer_STM32.svg?)](https://www.ardu-badge.com/EthernetWebServer_STM32)
44
[![GitHub release](https://img.shields.io/github/release/khoih-prog/EthernetWebServer_STM32.svg)](https://github.com/khoih-prog/EthernetWebServer_STM32/releases)
55
[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/khoih-prog/EthernetWebServer_STM32/blob/master/LICENSE)
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/EthernetWebServer_STM32.svg)](http://github.com/khoih-prog/EthernetWebServer_STM32/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-EthernetWebServer_STM32/count.svg" title="EthernetWebServer_STM32 Visitor count"><img src="https://profile-counter.glitch.me/khoih-prog-EthernetWebServer_STM32/count.svg" style="height: 30px;width: 200px;"></a>
14+
915
---
1016
---
1117

library.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
{
4545
"owner": "khoih-prog",
4646
"name": "Ethernet_Generic",
47-
"version": "^2.2.0"
47+
"version": "^2.7.1"
4848
}
4949
],
5050
"frameworks": "arduino",

platformio/platformio.ini

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,16 @@ lib_deps =
3636
; STM32duino LwIP@~2.1.2
3737
; STM32duino STM32Ethernet@~1.3.0
3838
; Functional-Vlpp@~1.0.2
39-
; UIPEthernet@~2.0.11
40-
; Ethernet_Generic>=2.2.0
41-
; EthernetENC@~2.0.2
39+
; UIPEthernet@~2.0.12
40+
; Ethernet_Generic>=2.7.1
41+
; EthernetENC@~2.0.3
4242
; PlatformIO 5.x
4343
stm32duino/STM32duino LwIP@~2.1.2
4444
stm32duino/STM32duino STM32Ethernet@~1.3.0
4545
khoih-prog/Functional-Vlpp@~1.0.2
46-
khoih-prog/Ethernet_Generic@~2.2.0
47-
uipethernet/UIPEthernet@~2.0.11
48-
jandrassy/EthernetENC@~2.0.2
46+
khoih-prog/Ethernet_Generic@~2.7.1
47+
uipethernet/UIPEthernet@~2.0.12
48+
jandrassy/EthernetENC@~2.0.3
4949

5050
build_flags =
5151
; set your build_flags

src/EthernetHttpClient_STM32.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,5 +44,5 @@
4444
#include "Ethernet_HTTPClient/Ethernet_WebSocketClient.h"
4545
#include "Ethernet_HTTPClient/Ethernet_URLEncoder.h"
4646

47-
#endif // ETHERNET_HTTP_CLIENT_STM32_H
47+
#endif // ETHERNET_HTTP_CLIENT_STM32_H
4848

0 commit comments

Comments
 (0)