Update README

This commit is contained in:
cpq 2022-09-11 13:42:59 +01:00
parent 76c4bb556f
commit 274c11c3ec
2 changed files with 17 additions and 6 deletions

View File

@ -20,6 +20,7 @@ robust, and easy. Features include:
- Tiny static and run-time footprint
- Source code is both ISO C and ISO C++ compliant
- Works with any network stack with socket API, like LwIP or FreeRTOS-Plus-TCP
- Optional [built-in IP stack](mip) for bare metal or RTOS-enabled applications
- Very easy to integrate: just copy `mongoose.c` and `mongoose.h` files to your build tree
- Detailed [documentation](https://mongoose.ws/documentation/) and
[tutorials](https://mongoose.ws/tutorials/)

View File

@ -1,9 +1,19 @@
# MIP - experimental TCP/IP stack for Mongoose Library
# MIP - a built-in TCP/IP stack for Mongoose Library
This bare-metal embedded TCP/IP stack is designed specifically for Mongoose.
It does not implement BSD sockets interface - instead, it implements
an event-based API tailored for Mongoose Library. As a result, it does not
need to use synchronisation primitives. It is very fast, and can work
with or without RTOS.
Works with or without RTOS. Makes it possible to implement networking without
any extra software - just drop `mongoose.c` and `mongoose.h` into your sources,
and you're done!
See example usage at [examples/stm32/nucleo-f746zg-baremetal](../examples/stm32/nucleo-f746zg-baremetal)
## Implemented drivers
- STM32F4xx
- STM32F7xx
- W5500
## Example usage
- [nucleo-f746 bare metal](../examples/stm32/nucleo-f746zg-baremetal)
- [nucleo-f429 bare metal](../examples/stm32/nucleo-f429zi-baremetal)
- (VIDEO) [stm32f7 with CubeIDE](https://www.youtube.com/watch?v=8htC_TSBeO0)
- [Xiao M0 SAMD21 Arduino + W5500](../examples/arduino/w5500)