Skip to content

Commit 88370d8

Browse files
Merge pull request #7277 from embhorn/readme_folders
Add directory layout to readme.
2 parents 3fd6af0 + 26c5c6f commit 88370d8

4 files changed

Lines changed: 48 additions & 5 deletions

File tree

IPP/.gitkeep

Whitespace-only changes.

Makefile.am

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,6 @@ dist_example_DATA=
138138

139139
ACLOCAL_AMFLAGS= -I m4
140140

141-
EXTRA_DIST+= lib/dummy
142-
143141
EXTRA_DIST+= wolfssl.vcproj
144142
EXTRA_DIST+= wolfssl.vcxproj
145143
EXTRA_DIST+= wolfssl64.sln
@@ -152,7 +150,6 @@ EXTRA_DIST+= README
152150
EXTRA_DIST+= ChangeLog.md
153151
EXTRA_DIST+= LICENSING
154152
EXTRA_DIST+= INSTALL
155-
EXTRA_DIST+= IPP
156153
EXTRA_DIST+= LPCExpresso.cproject
157154
EXTRA_DIST+= LPCExpresso.project
158155
EXTRA_DIST+= resource.h wolfssl.rc

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,3 +190,51 @@ More info can be found on-line at: https://wolfssl.com/wolfSSL/Docs.html
190190
[wolfSSL Vulnerabilities](https://www.wolfssl.com/docs/security-vulnerabilities/)
191191
192192
[Additional wolfSSL Examples](https://github.com/wolfssl/wolfssl-examples)
193+
194+
# Directory structure
195+
196+
```
197+
<wolfssl_root>
198+
├── certs [Certificates used in tests and examples]
199+
├── cmake [Cmake build utilities]
200+
├── debian [Debian packaging files]
201+
├── doc [Documentation for wolfSSL (Doxygen)]
202+
├── Docker [Prebuilt Docker environments]
203+
├── examples [wolfSSL examples]
204+
│   ├── asn1 [ASN.1 printing example]
205+
│   ├── async [Asynchronous Cryptography example]
206+
│   ├── benchmark [TLS benchmark example]
207+
│   ├── client [Client example]
208+
│   ├── configs [Example build configurations]
209+
│   ├── echoclient [Echoclient example]
210+
│   ├── echoserver [Echoserver example]
211+
│   ├── pem [Example for convert between PEM and DER]
212+
│   ├── sctp [Servers and clients that demonstrate wolfSSL's DTLS-SCTP support]
213+
│   └── server [Server example]
214+
├── IDE [Contains example projects for various development environments]
215+
├── linuxkm [Linux Kernel Module implementation]
216+
├── m4 [Autotools utilities]
217+
├── mcapi [wolfSSL MPLAB X Project Files]
218+
├── mplabx [wolfSSL MPLAB X Project Files]
219+
├── mqx [wolfSSL Freescale CodeWarrior Project Files]
220+
├── rpm [RPM packaging metadata]
221+
├── RTOS
222+
│   └── nuttx [Port of wolfSSL for NuttX]
223+
├── scripts [Testing scripts]
224+
├── src [wolfSSL source code]
225+
├── sslSniffer [wolfSSL sniffer can be used to passively sniff SSL traffic]
226+
├── support [Contains the pkg-config file]
227+
├── tests [Unit and configuration testing]
228+
├── testsuite [Test application that orchestrates tests]
229+
├── tirtos [Port of wolfSSL for TI RTOS]
230+
├── wolfcrypt [The wolfCrypt component]
231+
│   ├── benchmark [Cryptography benchmarking application]
232+
│   ├── src [wolfCrypt source code]
233+
│   │   └── port [Supported hardware acceleration ports]
234+
│   └── test [Cryptography testing application]
235+
├── wolfssl [Header files]
236+
│   ├── openssl [Compatibility layer headers]
237+
│   └── wolfcrypt [Header files]
238+
├── wrapper [wolfSSL language wrappers]
239+
└── zephyr [Port of wolfSSL for Zephyr RTOS]
240+
```

lib/dummy

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)