From 33630926cdac9c241cebc5ed18620148f043f5f7 Mon Sep 17 00:00:00 2001 From: Levi Rak Date: Fri, 2 Jun 2017 10:20:40 -0600 Subject: [PATCH] Readme test --- tls/README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/tls/README.md b/tls/README.md index 1d3f1207..cf35467c 100644 --- a/tls/README.md +++ b/tls/README.md @@ -19,3 +19,40 @@ examples are neither the most sophisticated nor robust. Instead, these examples are intended to be easy to follow and clear in demonstrating the basic procedure. It cannot be guaranteed that these programs will will be free of memory leaks, especially in error conditions. + +Tutorial +======== + +This portion of the `README` is dedicated to walking you through creating most +of the files in this directory. Before we begin, a note: all references to +files are made relative to this `tls/` directory. Any file reference should +then be modified to point to the correct location. It is also recommended that +you make a new directory to write your files into. If you make a new +subdirectory in the `tls/` directory, simply append an extra `../` to the front +of any file path. Another excellent choice is to make a new directory in the +root directory of this repository, such that there is no need to change the +file path. + +## Table of contents + +1. [A simple TCP client/server pair](#tcp) + 1. [Server](#server-tcp) + + +## A simple TCP client/server pair + +We'll begin by making a simple client/server pair that will communicate in +plaintext over a TCP socket. + +### Server<\a> + +We'll write the server first. We'll be rewriting [server-tcp.c] + + + + +[server-tcp.c]: https://github.com/wolfssl/wolfssl-examples/blob/master/tls/server-tcp.c +[client-tcp.c]: https://github.com/wolfssl/wolfssl-examples/blob/master/tls/client-tcp.c + +[server-tls.c]: https://github.com/wolfssl/wolfssl-examples/blob/master/tls/server-tls.c +[client-tls.c]: https://github.com/wolfssl/wolfssl-examples/blob/master/tls/client-tls.c