summaryrefslogtreecommitdiffstats
path: root/demos
diff options
context:
space:
mode:
authorMatt Caswell <matt@openssl.org>2023-10-25 13:10:59 +0100
committerHugo Landau <hlandau@openssl.org>2023-10-30 07:54:00 +0000
commitada33e98f53ab02dc4d6e8259c9e9edb6cd5c90c (patch)
tree7d2b7449ac16545c246da82b4cd007abd3960042 /demos
parentf666599f8dae9a892c28765cfbfe561fff52e213 (diff)
Add a separate README for the guide demos
Point users at the actual guide, and also explain about LD_LIBRARY_PATH Reviewed-by: Hugo Landau <hlandau@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/22505)
Diffstat (limited to 'demos')
-rw-r--r--demos/guide/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/demos/guide/README.md b/demos/guide/README.md
new file mode 100644
index 0000000000..f1cbf1ea3b
--- /dev/null
+++ b/demos/guide/README.md
@@ -0,0 +1,15 @@
+The OpenSSL Guide Demos
+=======================
+
+The demos in this directory are the complete source code for the applications
+developed in the OpenSSL Guide tutorials. Refer to the various tutorial pages in
+the [guide] for an extensive discussion on the demos available here.
+
+To run the demos when linked with a shared library (default) ensure that
+libcrypto and libssl are on the library path. For example, assuming you have
+already built OpenSSL from this source and in the default location then to run
+the tls-client-block demo do this:
+
+LD_LIBRARY_PATH=../.. ./tls-client-block
+
+[guide]: https://www.openssl.org/docs/manmaster/man7/ossl-guide-introduction.html