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

Commit 2806fad

Browse files
authored
Update README.md
To add some important notes and update Prerequisite
1 parent 1e3742e commit 2806fad

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
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+
911
### New in Version v1.0.2
1012

1113
1. Remove dependency on [`Functional-VLPP library`](https://github.com/khoih-prog/functional-vlpp).
@@ -35,9 +37,11 @@ Library is based on and modified from:
3537

3638
The EthernetWebServer class found in `EthernetWebServer.h` header, is a simple web server that knows how to handle HTTP requests such as GET and POST and can only support one simultaneous client.
3739

40+
---
41+
3842
## Prerequisite
3943
1. [`Arduino IDE 1.8.11 or later` for Arduino](https://www.arduino.cc/en/Main/Software)
40-
2. [`Arduino Core for STM32 1.8.0 or later`](https://github.com/stm32duino/Arduino_Core_STM32) for STM32 (Use Arduino Board Manager)
44+
2. [`Arduino Core for STM32 1.9.0 or later`](https://github.com/stm32duino/Arduino_Core_STM32) for STM32 (Use Arduino Board Manager)
4145
3. Depending on which Ethernet card you're using:
4246
- [STM32Ethernet library](https://github.com/stm32duino/STM32Ethernet) for built-in Ethernet on (Nucleo-144, Discovery)
4347
- [UIPEthernet library](https://github.com/UIPEthernet/UIPEthernet) for ENC28J60
@@ -58,6 +62,15 @@ You can also use this link [![arduino-library-badge](https://www.ardu-badge.com/
5862
4. Copy whole
5963
- `EthernetWebServer_STM32-master` folder to Arduino libraries' directory such as `~/Arduino/libraries/`.
6064

65+
---
66+
67+
#### Important Notes
68+
69+
1. Install the latest [`Arduino Core for STM32 1.9.0 or later`](https://github.com/stm32duino/Arduino_Core_STM32) for STM32
70+
2. Install the UIPthernet patch [new STM32 core F3/F4 compatibility](https://github.com/UIPEthernet/UIPEthernet/commit/c6d6519a260166b722b9cee5dd1f0fb2682e6782) to avoid errors `#include HardwareSPI.h` on some STM32 boards (Nucleo-32 F303K8, etc.)
71+
72+
73+
---
6174

6275
#### Usage
6376

@@ -208,6 +221,7 @@ Example:*
208221
size_t streamFile();
209222
```
210223

224+
---
211225

212226
Also see examples:
213227
1. [HelloServer](examples/HelloServer)
@@ -217,8 +231,9 @@ Also see examples:
217231
5. [PostServer](examples/PostServer)
218232
6. [SimpleAuthentication](examples/SimpleAuthentication)
219233

220-
## Example
221-
Please take a look at examples, as well.
234+
## Example [HelloServer](examples/HelloServer)
235+
236+
Please take a look at other examples, as well.
222237

223238
```cpp
224239
/*
@@ -346,7 +361,6 @@ The following are debug terminal output and screen shot when running example [Ad
346361
</p>
347362
348363
```
349-
350364
Starting AdvancedServer
351365
HTTP EthernetWebServer is @ IP : 192.168.2.100
352366
[ETHERNET_WEBSERVER] send1: len = 289
@@ -388,6 +402,8 @@ HTTP EthernetWebServer is @ IP : 192.168.2.100
388402
</svg>
389403
```
390404
405+
---
406+
391407
### New in Version v1.0.2
392408
393409
1. Remove dependendy on [`Functional-VLPP library`](https://github.com/khoih-prog/functional-vlpp).
@@ -422,7 +438,7 @@ This library currently supports
422438
423439
and these boards are not supported:
424440
425-
- Nucleo-32 (small Flash/memory)
441+
- Some Nucleo-32 (small Flash/memory)
426442
- Eval (no Serial, just need to redefine in sketch, library and UIPEthernet)
427443
- Generic STM32F0 (small Flash/memory)
428444
- Generic STM32F1 (with 64-K Flash): C6
@@ -437,9 +453,10 @@ and these boards are not supported:
437453
2. Add SSL/TLS Client and Server support
438454
3. Support more types of Ethernet shields such as W5x00, etc.
439455
456+
---
440457
441458
### Contributions and thanks
442-
1. Forked from [Ivan Grokhotkov's ESP8266WebServer](https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WebServer)
459+
1. Based on and modified from [Ivan Grokhotkov's ESP8266WebServer](https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WebServer)
443460
2. [jandrassy](https://github.com/jandrassy) for [UIPEthernet library](https://github.com/UIPEthernet/UIPEthernet)
444461
445462
## Contributing

0 commit comments

Comments
 (0)