Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
igrr committed Feb 26, 2016
1 parent c18bb56 commit 96fbb39
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,28 @@
Replacement for Espressif's libssl, kept as close as possible to [axTLS](http://axtls.sourceforge.net/) source.
Currently based on axTLS 1.4.9, will be upgraded to 1.5.3.

[![Build status](https://travis-ci.org/igrr/axtls-8266.svg)](https://travis-ci.org/igrr/axtls-8266)

This is not a self-sufficient library. Application has to provide the following symbols (list not complete yet):
```
malloc
calloc
free
abort
ax_port_malloc
ax_port_calloc
ax_port_realloc
ax_port_free
ax_port_read
ax_port_write
ax_port_open
ax_port_close
ax_get_file
phy_get_rand (provided by the IoT SDK)
ets_printf (in ESP8266 ROM)
ets_putc (in ESP8266 ROM)
gettimeofday
time
ctime
printf
vprintf
```

Additionally, functions for non-blocking TCP socket reads and writes have to be provided (details TBD).
For use with LwIP raw TCP API, see [compat/README.md](compat/README.md)

To build, add xtensa toolchain to your path, and run `make`.

Expand Down

0 comments on commit 96fbb39

Please sign in to comment.